Changeset 4836 in orxonox.OLD for orxonox/trunk/src/world_entities/player.cc

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:

• orxonox/trunk/src/world_entities/player.cc (modified) (15 diffs)

orxonox/trunk/src/world_entities/player.cc

@@ -41 +41 @@
 
 /**
-   \brief creates a new Player
-   \param isFree if the player is free
+ *  creates a new Player
+ * @param isFree if the player is free
 */
 Player::Player()
@@ -65 +65 @@
 
 /**
-   \brief destructs the player, deletes alocated memory
+ *  destructs the player, deletes alocated memory
 */
 Player::~Player ()
@@ -78 +78 @@
 
 /**
-   \brief creates a new Player from Xml Data
-   \param root the xml element containing player data
-
-   \todo add more parameters to load
+ *  creates a new Player from Xml Data
+ * @param root the xml element containing player data
+
+   @todo add more parameters to load
 */
 Player::Player(const TiXmlElement* root)
@@ -132 +132 @@
 
 /**
-   \brief adds a weapon to the weapon list of player
-   \param weapon to add
+ *  adds a weapon to the weapon list of player
+ * @param weapon to add
 */
 void Player::addWeapon(Weapon* weapon)
@@ -142 +142 @@
 
 /**
-   \brief removes a weapon from the player
-   \param weapon to remove
+ *  removes a weapon from the player
+ * @param weapon to remove
 */
 void Player::removeWeapon(Weapon* weapon)
@@ -152 +152 @@
 
 /**
-   \brief effect that occurs after the player is spawned
+ *  effect that occurs after the player is spawned
 */
 void Player::postSpawn ()
@@ -161 +161 @@
 
 /**
-   \brief the action occuring if the player left the game
+ *  the action occuring if the player left the game
 */
 void Player::leftWorld ()
@@ -169 +169 @@
 
 /**
-   \brief if the player is hit, call this function
-   \param weapon hit by this weapon
-   \param loc ??
+ *  if the player is hit, call this function
+ * @param weapon hit by this weapon
+ * @param loc ??
 */
 void Player::hit (WorldEntity* weapon, Vector* loc)
@@ -179 +179 @@
 
 /**
-    \brief Collision with another Entity has this effect
-    \param other the other colider
-    \param ownhitflags ??
-    \param otherhitflags ??
+  *  Collision with another Entity has this effect
+  * @param other the other colider
+  * @param ownhitflags ??
+  * @param otherhitflags ??
 */
 void Player::collide (WorldEntity* other, Uint32 ownhitflags, Uint32 otherhitflags)
@@ -190 +190 @@
 
 /**
-   \brief draws the player after transforming him.
+ *  draws the player after transforming him.
 */
 void Player::draw ()
@@ -214 +214 @@
 
 /**
-   \brief the function called for each passing timeSnap
-   \param time The timespan passed since last update
+ *  the function called for each passing timeSnap
+ * @param time The timespan passed since last update
 */
 void Player::tick (float time)
@@ -234 +234 @@
 
 /**
-   \brief action if player moves
-   \param time the timeslice since the last frame
+ *  action if player moves
+ * @param time the timeslice since the last frame
 */
 void Player::move (float time)
@@ -256 +256 @@
     accel = accel + (orthDirection*acceleration);
   if( this->bAscend )
-  if( this->bDescend) {/* FIXME */} /* \todo up and down player movement */
+  if( this->bDescend) {/* FIXME */} /* @todo up and down player movement */
 
   Vector move = accel * time;
@@ -264 +264 @@
 
 /**
-   \brief weapon manipulation by the player
+ *  weapon manipulation by the player
 */
 void Player::weapon()
@@ -281 +281 @@
 
 /**
-   \brief The connection to the command node
-   \param cmd the Command unit from witch to map
+ *  The connection to the command node
+ * @param cmd the Command unit from witch to map
 
    here the commands are mapped to the players movement/weaponary