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/questsystem
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/src/modules/questsystem/AddQuestHint.cc

    r7163 r7297  
    8080    @param id
    8181        The QuestHint id.
    82     @param
     82    @return
    8383        Returns true if successful.
    8484    */

  • code/branches/doc/src/modules/questsystem/Quest.cc

    r7163 r7297  
    197197    @brief
    198198        Returns the subquest at the given index.
    199     @param
     199    @param index
    200200        The index.
    201201    @return
    … …  
    222222    @brief
    223223        Returns the QuestHint at the given index.
    224     @param
     224    @param index
    225225        The index.
    226226    @return
    … …  
    246246    @brief
    247247        Returns the fail QuestEffect at the given index.
    248     @param
     248    @param index
    249249        The index.
    250250    @return
    … …  
    270270    @brief
    271271        Returns the complete QuestEffect at the given index.
    272     @param
     272    @param index
    273273        The index.
    274274    @return

  • code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc

    r7163 r7297  
    9292        Executes the QuestEffectBeacon.
    9393        This means extracting the Pawn from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received Pawn and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
     94    @param b
     95        true means the trigger was activated while false means it was deactivated
    9496    @param trigger
    9597        A pointer to the PlayerTrigger that threw the Event.

  • code/branches/doc/src/modules/questsystem/QuestNotification.cc

    r7163 r7297  
    4848    @brief
    4949        Creates a QuestNotification with the input message.
     50    @param creator
     51        The creator of this object
    5052    @param message
    5153        The message to be sent.
Note: See TracChangeset for help on using the changeset viewer.