Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orxonox/trunk/src/world_entities/weapons/weapon.cc

    r4834 r4836  
    2525
    2626/**
    27    \brief standard constructor
     27 * standard constructor
    2828
    2929   creates a new weapon
     
    3838
    3939/**
    40    \brief standard deconstructor
     40 * standard deconstructor
    4141*/
    4242Weapon::~Weapon ()
     
    5252
    5353/**
    54     \brief enables the weapon
     54  * enables the weapon
    5555
    5656    a weapon can be enabled/disabled because of various reasons. if a weapon is
     
    6565
    6666/**
    67     \brief disables the weapon
     67  * disables the weapon
    6868
    6969    a weapon can be enabled/disabled because of various reasons. if a weapon is
     
    7878
    7979/**
    80     \brief checks if the weapon is enabled
    81     \returns true if enabled
     80  * checks if the weapon is enabled
     81  * @returns true if enabled
    8282
    8383    a weapon can be ebabled/disabled because of various reasons. if a weapon is
     
    9292
    9393/**
    94    \brief sets a new projectile to the weapon
    95    \param new projectile for this weapon
     94 * sets a new projectile to the weapon
     95 * @param new projectile for this weapon
    9696
    9797   weapon an projectile are independent, so you can combine them as you want
     
    104104
    105105/**
    106    \brief sets a new projectile to the weapon
    107    \returns the current projectile of this weapon
     106 * sets a new projectile to the weapon
     107 * @returns the current projectile of this weapon
    108108
    109109   weapon an projectile are independent, so you can combine them as you want
     
    116116
    117117/**
    118    \brief this activates the weapon
     118 * this activates the weapon
    119119
    120120   This is needed, since there can be more than one weapon on a ship. the
     
    127127
    128128/**
    129    \brief this deactivates the weapon
     129 * this deactivates the weapon
    130130
    131131   This is needed, since there can be more than one weapon on a ship. the
     
    137137
    138138/**
    139    \brief asks if the current weapon is active
    140    \returns true if it the weapon is active
     139 * asks if the current weapon is active
     140 * @returns true if it the weapon is active
    141141*/
    142142bool Weapon::isActive()
     
    149149
    150150/**
    151    \brief is called, when the weapon gets hit (=collide with something)
    152    \param from which entity it is been hit
    153    \param where it is been hit
     151 * is called, when the weapon gets hit (=collide with something)
     152 * @param from which entity it is been hit
     153 * @param where it is been hit
    154154
    155155   this may not be used, since it would make the game relay complicated when one
     
    161161
    162162/**
    163    \brief is called, when the weapon is destroyed
     163 * is called, when the weapon is destroyed
    164164
    165165   this is in conjunction with the hit function, so when a weapon is able to get
     
    171171
    172172/**
    173    \brief tick signal for time dependent/driven stuff
     173 * tick signal for time dependent/driven stuff
    174174*/
    175175void Weapon::tick (float time)
     
    178178
    179179/**
    180    \brief is called, when there is no fire button pressed
     180 * is called, when there is no fire button pressed
    181181*/
    182182void Weapon::weaponIdle()
     
    185185
    186186/**
    187    \brief this will draw the weapon
     187 * this will draw the weapon
    188188*/
    189189void Weapon::draw ()
Note: See TracChangeset for help on using the changeset viewer.