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.

Location:
code/branches/doc/src/libraries/core
Files:
20 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/src/libraries/core/BaseObject.cc

    r7284 r7297  
    116116        @brief XML loading and saving.
    117117        @param xmlelement The XML-element
    118         @param loading Loading (true) or saving (false)
     118        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
    119119    */
    120120    void BaseObject::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    … …  
    141141        @brief Defines the possible event states of this object and parses eventsources from an XML file.
    142142        @param xmlelement The XML-element
    143         @param loading Loading (true) or saving (false)
     143        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
    144144    */
    145145    void BaseObject::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)

  • code/branches/doc/src/libraries/core/CommandLineParser.cc

    r7284 r7297  
    126126    @param arguments
    127127        Vector of space separated strings.
     128    @param bParsingFile
     129        FIXME - add doc!
    128130    */
    129131    void CommandLineParser::_parse(const std::vector<std::string>& arguments, bool bParsingFile)
    … …  
    244246    @param value
    245247        String containing the value
     248    @param bParsingFile
     249        FIXME - add doc!
    246250    */
    247251    void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value, bool bParsingFile)
    … …  
    261265    @param value
    262266        String containing the value
     267    @param bParsingFile
     268        FIXME - add doc!
    263269    */
    264270    void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value, bool bParsingFile)

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

    r7284 r7297  
    207207    @param defaultValue
    208208        Default value that is used when argument was not given.
     209    @param bCommandLineOnly
     210        FIXME - add doc!
    209211    */
    210212    template <class T>

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

    r6536 r7297  
    117117                @param type The type of the corresponding config-file
    118118                @param identifier The identifier of the class the variable belongs to
     119                @param sectionname Name of the section the configValue should be put in.
    119120                @param varname The name of the variable
    120121                @param defvalue The default-value
     122                @param value Only needed do determine the right type.
    121123            */
    122124            template <class D, class V>

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

    r6423 r7297  
    101101    /**
    102102        @brief Returns the Identifier with a given name.
    103         @param String The name of the class
     103        @param name The name of the class
    104104    */
    105105    inline Identifier* ClassByString(const std::string& name)
    … …  
    110110    /**
    111111        @brief Returns the Identifier with a given lowercase name.
    112         @param String The lowercase name of the class
     112        @param name The lowercase name of the class
    113113    */
    114114    inline Identifier* ClassByLowercaseString(const std::string& name)
    … …  
    119119    /**
    120120        @brief Returns the Identifier with a given network ID.
    121         @param networkID The network ID of the class
     121        @param id The network ID of the class
    122122    */
    123123    inline Identifier* ClassByID(uint32_t id)
    … …  
    130130        @note This of course only works with OrxonoxClasses.
    131131              The only use is in conjunction with macros that don't know the class type.
    132         @param Pointer to an OrxonoxClass
     132        @param object Pointer to an OrxonoxClass
    133133    */
    134134    template <class T>

  • 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);

  • code/branches/doc/src/libraries/core/GUIManager.cc

    r7284 r7297  
    110110        After Lua setup tolua++-elements are linked to Lua-state to give Lua access to C++-code.
    111111        Finally initial Lua code is executed (maybe we can do this with the CEGUI startup script automatically).
    112     @param renderWindow
    113         Ogre's render window. Without this, the GUI cannot be displayed.
    114112    @return true if success, otherwise false
    115113    */
    … …  
    237235    @param name
    238236        The name of the GUI
     237    @param bHidePrevious
     238        FIXME - add doc!
    239239
    240240        The function executes the Lua function with the same name in case the GUIManager is ready.

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

    r7284 r7297  
    387387        @brief Adds an object of the given type to the ObjectList.
    388388        @param object The object to add
     389        @param className The name of the class T
     390        @param bRootClass True if this is a root class (i.e. it inherits directly from OrxonoxClass)
    389391    */
    390392    template <class T>

  • code/branches/doc/src/libraries/core/Language.cc

    r7284 r7297  
    168168        @brief Returns the localisation of a given entry.
    169169        @param label The label of the entry
     170        @param bError If true, an error is printed if the label doesn't exist and the default localisation is returned. If false, no error is printed and an empty string is returned.
    170171        @return The localisation
    171172    */

  • code/branches/doc/src/libraries/core/Namespace.cc

    r6417 r7297  
    5555    }
    5656
    57     /**
    58         @brief XML loading and saving.
    59         @param xmlelement The XML-element
    60         @param loading Loading (true) or saving (false)
    61         @return The XML-element
    62     */
    6357    void Namespace::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    6458    {

  • code/branches/doc/src/libraries/core/ObjectListBase.cc

    r5738 r7297  
    7070    /**
    7171        @brief Increases all Iterators that currently point on the given element (because it gets removed).
    72         @param element The element that gets removed
     72        @param object The object that gets removed
    7373    */
    7474    void ObjectListBase::notifyIterators(OrxonoxClass* object) const
    … …  
    8282    /**
    8383        @brief Adds a new object to the end of the list.
    84         @param object The object to add
     84        @param element The element to add
    8585        @return The pointer to the new ObjectListBaseElement, needed by the MetaObjectList of the added object
    8686    */

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

    r5738 r7297  
    5454            /**
    5555                @brief Constructor: Creates the list-element with an object.
    56                 @param object The object to store
     56                @param objectBase The object to store
    5757            */
    5858            ObjectListBaseElement(OrxonoxClass* objectBase) : next_(0), prev_(0), objectBase_(objectBase) {}

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

    r7268 r7297  
    109109            /**
    110110                @brief Assigns the element of another ObjectListIterator.
    111                 @param element The other ObjectListIterator
     111                @param other The other ObjectListIterator
    112112            */
    113113            inline ObjectListIterator<T>& operator=(const ObjectListIterator<T>& other)

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

    r6746 r7297  
    105105        /**
    106106            Find out if the named file exists.
    107         @param filename
     107        @param name
    108108            Fully qualified name of the file to test for
    109109        */
    … …  
    112112        /**
    113113            Get struct with information about path and size.
    114         @param filename
     114        @param name
    115115            Fully qualified name of the file to test for
    116116        */

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

    r7291 r7297  
    148148    @param paramname The name of the attribute
    149149    @param loadfunction The function to set the attribute inside of the member object.
    150     @param loadfunction The function to get the attribute from the member object
     150    @param savefunction The function to get the attribute from the member object
     151    @param xmlelement The XML-element that is parsed by this macro
     152    @param mode Loading or saving
    151153
    152154    Sometimes you'll have a member object in your class, which has it's own load- and savefunctions.
    … …  
    196198    @param sectionname The name of the subsection in the XML file that encloses the sub-objects ("" means no subsection)
    197199    @param loadfunction The function to add a new object to the class
    198     @param loadfunction The function to get all added objects from the class
     200    @param savefunction The function to get all added objects from the class
    199201    @param xmlelement The XMLElement (received through the XMLPort function)
    200202    @param mode The mode (load/save) (received through the XMLPort function)

  • code/branches/doc/src/libraries/core/command/TclThreadList.h

    r7284 r7297  
    7171
    7272            /**
    73                 @brief Returns a reference to the mutex which might be useful if you want to iterate through the list (see @ref begin and @ref end).
     73                @brief Returns a reference to the mutex which might be useful if you want to iterate through the list (see @ref getList()).
    7474            */
    7575            inline boost::shared_mutex& getMutex() const

  • code/branches/doc/src/libraries/core/command/TclThreadManager.cc

    r7284 r7297  
    303303    /**
    304304        @brief Sends a command to the queue of a given Tcl-interpreter
    305         @param id The id of the target interpreter
     305        @param target_id The id of the target interpreter
    306306        @param command The command to be sent
    307307    */
    … …  
    326326        @brief This function can be called from Tcl to send a command to the queue of any interpreter.
    327327        @param target_id The id of the target thread
     328        @param args Contains the content of the command
    328329    */
    329330    void TclThreadManager::tcl_crossexecute(int target_id, const Tcl::object& args)
    … …  
    334335    /**
    335336        @brief Sends a command to the queue of a given Tcl-interpreter
    336         @param id The id of the target interpreter
     337        @param target_id The id of the target interpreter
    337338        @param command The command to be sent
    338339    */
    … …  
    347348    /**
    348349        @brief Sends a query to a given Tcl-interpreter and waits for the result
    349         @param id The id of the target interpreter
     350        @param target_id The id of the target interpreter
    350351        @param command The command to be sent
    351352        @return The result of the command
    … …  
    359360        @brief This function can be called from Tcl to send a query to the main thread.
    360361        @param source_id The id of the calling thread
     362        @param args Contains the content of the query
    361363
    362364        A query waits for the result of the command. This means, the calling thread will be blocked until
    … …  
    373375        @param source_id The id of the calling thread
    374376        @param target_id The id of the target thread
     377        @param args Contains the content of the query
    375378    */
    376379    std::string TclThreadManager::tcl_crossquery(int source_id, int target_id, const Tcl::object& args)

  • code/branches/doc/src/libraries/core/input/InputManager.cc

    r7284 r7297  
    140140        Creates the OIS::InputMananger, the keyboard, the mouse and
    141141        the joys ticks. If either of the first two fail, this method throws an exception.
    142     @param windowWidth
    143         The width of the render window
    144     @param windowHeight
    145         The height of the render window
    146142    */
    147143    void InputManager::loadDevices()

  • code/branches/doc/src/libraries/core/input/InputManager.h

    r6746 r7297  
    122122        @param name
    123123            Unique name of the InputState when referenced as string
     124        @param bAlwaysGetsInput
     125            FIXME - add doc!
     126        @param bTransparent
     127            FIXME - add doc!
    124128        @param priority
    125129            Priority matters when multiple states are active. You can specify any

  • code/branches/doc/src/libraries/core/input/KeyBinder.cc

    r6536 r7297  
    495495    @brief
    496496        Event handler for the mouseMoved Event.
    497     @param e
    498         Mouse state information
     497    @param abs_
     498        The absolute position of the mouse
     499    @param rel_
     500        The relative movement of the mouse
     501    @param clippingSize
     502        FIXME - no doc? param not even used?
    499503    */
    500504    void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
    … …  
    551555    /**
    552556    @brief Event handler for the mouseScrolled Event.
    553     @param e Mouse state information
     557    @param abs The absolute position of the scroll wheel
     558    @param rel The relative movement of the scroll wheel
    554559    */
    555560    void KeyBinder::mouseScrolled(int abs, int rel)
Note: See TracChangeset for help on using the changeset viewer.