Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 8447


Ignore:
Timestamp:
May 11, 2011, 10:44:25 PM (13 years ago)
Author:
dafrick
Message:

Resolving some doxygen warnings.

Location:
code/branches/tutoriallevel2
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • code/branches/tutoriallevel2/doc/api/groups/Triggers.dox

    r8351 r8447  
    5555    - @b target Which specifies the class of objects that can trigger the @ref orxonox::DistanceTrigger "DistanceTrigger". Default is <code>"Pawn"</code>.
    5656    - @b beaconMode Which specifies, whether the @ref orxonox::DistanceTrigger "DistanceTrigger" operates on @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" or not. If <em>off</em> the DistanceMultiTrigger works as usual. If set to <em>identify</em> the @ref orxonox::DistanceTrigger "DistanceTrigger" is only triggered by objects that have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. If set to <em>exclude</em> the @ref orxonox::DistanceTrigger "DistanceTrigger" is only triggered by objects that don't have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. Default is <em>off</em>.
    57     - @b targetname Which specifies the name @ref oroxnox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the @ref orxonox::DistanceTrigger "DistanceTrigger" react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
     57    - @b targetname Which specifies the name @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the @ref orxonox::DistanceTrigger "DistanceTrigger" react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
    5858
    5959    A simple @ref orxonox::DistanceTrigger "DistanceTrigger" could look like this:
  • code/branches/tutoriallevel2/src/libraries/network/synchronisable/Synchronisable.cc

    r8329 r8447  
    383383  /**
    384384   * This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction)
    385    * @param id gamestate id
    386385   * @param mode Synchronisation mode (toclient, toserver or bidirectional)
    387386   * @return true/false
     
    397396  /**
    398397   * This function determines, wheter the object should accept data from the bytestream (according to its syncmode/direction)
    399    * @param id gamestate id
    400398   * @param mode Synchronisation mode (toclient, toserver or bidirectional)
    401399   * @return true/false
  • code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc

    r8213 r8447  
    280280        Check whether the DistanceTrigger is triggered.
    281281        It is triggered if it is triggered according only to its mode (i.e. its sub-triggers) and if a target is in range.
    282     @param
     282    @param mode
     283        The mode for which it is tested, whether the DistanceTrigger is triggered.
     284    @return
    283285        Returns true if it is triggered ,false if not.
    284286    */
  • code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h

    r8213 r8447  
    7171        - @b target Which specifies the class of objects that can trigger the DistanceTrigger. Default is <code>"Pawn"</code>.
    7272        - @b beaconMode Which specifies, whether the DistanceTrigger operates on @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" or not. If <em>off</em> the DistanceMultiTrigger works as usual. If set to <em>identify</em> the DistanceTrigger is only triggered by objects that have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. If set to <em>exclude</em> the DistanceTrigger is only triggered by objects that don't have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. Default is <em>off</em>.
    73         - @b targetname Which specifies the name @ref oroxnox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the DistanceTrigger react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
     73        - @b targetname Which specifies the name @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the DistanceTrigger react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
    7474
    7575        A simple DistanceTrigger could look like this:
  • code/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h

    r8213 r8447  
    6060
    6161    @see Trigger
    62         For more information on @ref oroxnox::Trigger "Triggers".
     62        For more information on @ref orxonox::Trigger "Triggers".
    6363
    6464    @author
  • code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc

    r8371 r8447  
    318318    @param player
    319319        The player.
    320     @return Returns the number of QuestHints of the input Quest for the input player.
     320    @return
     321        Returns the number of QuestHints of the input Quest for the input player.
    321322    */
    322323    int QuestManager::getNumHints(Quest* quest, PlayerInfo* player)
     
    341342    @param index
    342343        The index of the QuestHint.
     344    @return
     345        Returns a pointer to the index-th QuestHint of the input Quest for the input player.
    343346    */
    344347    QuestHint* QuestManager::getHints(Quest* quest, PlayerInfo* player, int index)
     
    355358    /**
    356359    @brief
    357         Get the parent-quest of the input Quest for the input player.
     360        Get the parent-quest of the input Quest.
    358361    @param quest
    359362        The Quest to get the parent-quest of.
    360     @param player
    361         The player.
     363    @return
     364        Returns a pointer to the parent-quest of the input Quest.
    362365    */
    363366    Quest* QuestManager::getParentQuest(Quest* quest)
Note: See TracChangeset for help on using the changeset viewer.