[Orxonox-commit 2666] r7371 - in code/branches/doc: doc/api src/libraries/util

[landauf at orxonox.net]

Author: landauf
Date: 2010-09-07 00:53:31 +0200 (Tue, 07 Sep 2010)
New Revision: 7371

Modified:
   code/branches/doc/doc/api/main.dox
   code/branches/doc/src/libraries/util/Clock.h
   code/branches/doc/src/libraries/util/Convert.h
   code/branches/doc/src/libraries/util/Exception.h
   code/branches/doc/src/libraries/util/ExprParser.h
   code/branches/doc/src/libraries/util/MathConvert.h
   code/branches/doc/src/libraries/util/OrxAssert.h
   code/branches/doc/src/libraries/util/OrxEnum.h
   code/branches/doc/src/libraries/util/TriBool.h
Log:
Moved some header files in util to suitable Doxygen groups.
Enhanced the main-page of Doxygen

Modified: code/branches/doc/doc/api/main.dox
===================================================================
--- code/branches/doc/doc/api/main.dox	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/doc/api/main.dox	2010-09-06 22:53:31 UTC (rev 7371)
@@ -1,4 +1,13 @@
 /**
- at 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.
 */

Modified: code/branches/doc/src/libraries/util/Clock.h
===================================================================
--- code/branches/doc/src/libraries/util/Clock.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/Clock.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -26,6 +26,11 @@
  *
  */
 
+/**
+    @file
+    @ingroup Util
+*/
+
 #ifndef _Clock_H__
 #define _Clock_H__
 
@@ -42,7 +47,7 @@
         Precision: <br>
     @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>
         Furthermore it might be possible that the Ogre::Timer has a performance

Modified: code/branches/doc/src/libraries/util/Convert.h
===================================================================
--- code/branches/doc/src/libraries/util/Convert.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/Convert.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -27,8 +27,14 @@
  *      ...
  */
 
+/**
+    @defgroup Convert Conversion functions
+    @ingroup Util
+*/
+
 /** Functions that convert values between different types.
 @file
+ at ingroup Convert
 @par Usage
     There are three ways to use the conversions depending on what you need. <br>
     - For simply converting values without having to know whether the conversion

Modified: code/branches/doc/src/libraries/util/Exception.h
===================================================================
--- code/branches/doc/src/libraries/util/Exception.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/Exception.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -27,7 +27,13 @@
  */
 
 /**
+    @defgroup ExceptionAssertion Exceptions and assertions
+    @ingroup Util
+*/
+
+/**
 @file
+ at ingroup ExceptionAssertion
 @brief
     Declaration of facilities to handle exceptions.
 @details

Modified: code/branches/doc/src/libraries/util/ExprParser.h
===================================================================
--- code/branches/doc/src/libraries/util/ExprParser.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/ExprParser.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -28,6 +28,7 @@
 
 /**
 @file
+ at ingroup Util
 @brief Declaration of FloatParser
 */
 

Modified: code/branches/doc/src/libraries/util/MathConvert.h
===================================================================
--- code/branches/doc/src/libraries/util/MathConvert.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/MathConvert.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -28,6 +28,7 @@
 
 /**
 @file
+ at ingroup Convert
 @brief
     Conversion functions for Math types like Ogre::Vector3 (definitions are in Math.cc)
 */

Modified: code/branches/doc/src/libraries/util/OrxAssert.h
===================================================================
--- code/branches/doc/src/libraries/util/OrxAssert.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/OrxAssert.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -28,6 +28,7 @@
 
 /**
 @file
+ at ingroup ExceptionAssertion
 @brief
     Declaration of custom assertion facilities
 */

Modified: code/branches/doc/src/libraries/util/OrxEnum.h
===================================================================
--- code/branches/doc/src/libraries/util/OrxEnum.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/OrxEnum.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -26,6 +26,11 @@
  *
  */
 
+/**
+    @file
+    @ingroup Util
+*/
+
 #ifndef _OrxEnum_H__
 #define _OrxEnum_H__
 

Modified: code/branches/doc/src/libraries/util/TriBool.h
===================================================================
--- code/branches/doc/src/libraries/util/TriBool.h	2010-09-06 19:44:37 UTC (rev 7370)
+++ code/branches/doc/src/libraries/util/TriBool.h	2010-09-06 22:53:31 UTC (rev 7371)
@@ -26,6 +26,11 @@
  *
  */
 
+/**
+    @file
+    @ingroup Util
+*/
+
 #ifndef _TriBool_H__
 #define _TriBool_H__