Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 31, 2010, 8:37:29 PM (14 years ago)
Author:
landauf
Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/src/libraries/core/DynLibManager.h

    r5738 r7297  
    5656
    5757        public:
    58             /** Default constructor.
    59                 @note
    60                     <br>Should never be called as the singleton is automatically
    61                     created during the creation of the Root object.
    62                 @see
    63                     Root::Root
     58            /**
     59            @brief
     60                Default constructor.
     61            @note
     62                Should never be called as the singleton is automatically
     63                created during the creation of the Root object.
     64            @see
     65                Root::Root
    6466            */
    6567            DynLibManager();
    6668
    67             /** Default destructor.
    68                 @see
    69                     Root::~Root
     69            /**
     70            @brief
     71                Default destructor.
     72            @see
     73                Root::~Root
    7074            */
    7175            virtual ~DynLibManager();
    7276
    73             /** Loads the passed library.
    74                 @param
    75                     filename The name of the library. The extension can be omitted
     77            /**
     78            @brief
     79                Loads the passed library.
     80            @param filename
     81                The name of the library. The extension can be omitted
    7682            */
    7783            DynLib* load(const std::string& filename);
    7884
    79             /** Unloads the passed library.
    80             @param
    81             filename The name of the library. The extension can be omitted
     85            /**
     86            @brief
     87                Unloads the passed library.
     88            @param lib
     89                A pointer to the library object
    8290            */
    8391            void unload(DynLib* lib);
Note: See TracChangeset for help on using the changeset viewer.