Context Navigation

Changeset 7371 for code/branches/doc

Timestamp:

Sep 7, 2010, 12:53:31 AM (14 years ago)

Author:

landauf

Message:

Moved some header files in util to suitable Doxygen groups.
Enhanced the main-page of Doxygen

Location:

code/branches/doc

Files:

-                      r6417
+                      r7371
 /**
+@mainpage
+    Orxonox Doxygen Reference
+    @mainpage
+    This is the documentation of Orxonox. It contains descriptions of our classes and functions and
+    explains their usage with several examples and background information. Because Orxonox is so big,
+    we can't document all of our code - sorry for that! But we do your best to document the most
+    important parts of it, namely the @ref Core "core" and @ref Util "util" libraries, as well as the
+    central classes in the @ref Orxonox "orxonox" main library and some @ref Modules "modules".
+    To understand the connection between different classes in Orxonox, have a look at the
+    <a href="modules.html"><b>Modules section</b></a>. It contains a list of the most important topics
+    and groups files that contribute to the same feature.
 */

-                      r7367
+                      r7371
  */
+/**
+    @file
+    @ingroup Util
+*/
 #ifndef _Clock_H__
 #define _Clock_H__
 …
     @par Precision
         The maximum precision is given by the Ogre::Timer and that is somewhere
         in the microsecond range for both Windows and UNIX.
+        in the microsecond range for both Windows and UNIX.
     @par Remarks for Usage on Windows
         For proper functionality this class MUST be used in the same thread! <br>

-                      r7365
+                      r7371
  */
+/**
+    @defgroup Convert Conversion functions
+    @ingroup Util
+*/
 /** Functions that convert values between different types.
 @file
+@ingroup Convert
 @par Usage
     There are three ways to use the conversions depending on what you need. <br>

-                      r7367
+                      r7371
 /**
+    @defgroup ExceptionAssertion Exceptions and assertions
+    @ingroup Util
+*/
+/**
 @file
+@ingroup ExceptionAssertion
 @brief
     Declaration of facilities to handle exceptions.

r7367	r7371
29	29	/**
30	30	@file
	31	@ingroup Util
31	32	@brief Declaration of FloatParser
32	33	*/

r7367	r7371
29	29	/**
30	30	@file
	31	@ingroup Convert
31	32	@brief
32	33	Conversion functions for Math types like Ogre::Vector3 (definitions are in Math.cc)

r7367	r7371
29	29	/**
30	30	@file
	31	@ingroup ExceptionAssertion
31	32	@brief
32	33	Declaration of custom assertion facilities

-                      r7367
+                      r7371
+ *
  */
+/**
+    @file
+    @ingroup Util
+*/
 #ifndef _OrxEnum_H__

-                      r7367
+                      r7371
  */
+/**
+    @file
+    @ingroup Util
+*/
 #ifndef _TriBool_H__
 #define _TriBool_H__

Note: See TracChangeset for help on using the changeset viewer.