Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7371 for code


Ignore:
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:
9 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/doc/api/main.dox

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

  • code/branches/doc/src/libraries/util/Clock.h

    r7367 r7371  
    2727 */
    2828
     29/**
     30    @file
     31    @ingroup Util
     32*/
     33
    2934#ifndef _Clock_H__
    3035#define _Clock_H__
    … …  
    4348    @par Precision
    4449        The maximum precision is given by the Ogre::Timer and that is somewhere
    45         in the microsecond range for both Windows and UNIX. 
     50        in the microsecond range for both Windows and UNIX.
    4651    @par Remarks for Usage on Windows
    4752        For proper functionality this class MUST be used in the same thread! <br>

  • code/branches/doc/src/libraries/util/Convert.h

    r7365 r7371  
    2828 */
    2929
     30/**
     31    @defgroup Convert Conversion functions
     32    @ingroup Util
     33*/
     34
    3035/** Functions that convert values between different types.
    3136@file
     37@ingroup Convert
    3238@par Usage
    3339    There are three ways to use the conversions depending on what you need. <br>

  • code/branches/doc/src/libraries/util/Exception.h

    r7367 r7371  
    2828
    2929/**
     30    @defgroup ExceptionAssertion Exceptions and assertions
     31    @ingroup Util
     32*/
     33
     34/**
    3035@file
     36@ingroup ExceptionAssertion
    3137@brief
    3238    Declaration of facilities to handle exceptions.

  • code/branches/doc/src/libraries/util/ExprParser.h

    r7367 r7371  
    2929/**
    3030@file
     31@ingroup Util
    3132@brief Declaration of FloatParser
    3233*/

  • code/branches/doc/src/libraries/util/MathConvert.h

    r7367 r7371  
    2929/**
    3030@file
     31@ingroup Convert
    3132@brief
    3233    Conversion functions for Math types like Ogre::Vector3 (definitions are in Math.cc)

  • code/branches/doc/src/libraries/util/OrxAssert.h

    r7367 r7371  
    2929/**
    3030@file
     31@ingroup ExceptionAssertion
    3132@brief
    3233    Declaration of custom assertion facilities

  • code/branches/doc/src/libraries/util/OrxEnum.h

    r7367 r7371  
    2626 *
    2727 */
     28
     29/**
     30    @file
     31    @ingroup Util
     32*/
    2833
    2934#ifndef _OrxEnum_H__

  • code/branches/doc/src/libraries/util/TriBool.h

    r7367 r7371  
    2727 */
    2828
     29/**
     30    @file
     31    @ingroup Util
     32*/
     33
    2934#ifndef _TriBool_H__
    3035#define _TriBool_H__
Note: See TracChangeset for help on using the changeset viewer.