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/modules/objects
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • code/branches/doc/src/modules/objects/Planet.cc

    r7163 r7297  
    144144    }
    145145
    146     /**
    147         @brief XML loading and saving.
    148         @param xmlelement The XML-element
    149         @param loading Loading (true) or saving (false)
    150         @return The XML-element
    151     */
    152146    void Planet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    153147    {
  • code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h

    r7163 r7297  
    6565            /**
    6666            @brief Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
    67             @param targename The name of the DistanceTriggerBeacon as a string.
     67            @param targetname The name of the DistanceTriggerBeacon as a string.
    6868            */
    6969            inline void setTargetName(const std::string& targetname)
  • code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc

    r7163 r7297  
    308308    @brief
    309309        Get whether the MultiTrigger is active for a given object.
    310     @param triggerers
     310    @param triggerer
    311311        A pointer to the object.
    312312    @return
Note: See TracChangeset for help on using the changeset viewer.