Author: mordante
Date: Thu May 22 19:40:20 2008
New Revision: 26777
URL: http://svn.gna.org/viewcvs/wesnoth?rev=26777&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/unit_display.cpp
trunk/src/unit_display.hpp
Modified: trunk/src/unit_display.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/unit_display.cpp?rev=26777&r1=26776&r2=26777&view=diff
==============================================================================
--- trunk/src/unit_display.cpp (original)
+++ trunk/src/unit_display.cpp Thu May 22 19:40:20 2008
@@ -12,8 +12,7 @@
See the COPYING file for more details.
*/
-//! @file unit_display.cpp
-//!
+/** @file unit_display.cpp */
#include "global.hpp"
Modified: trunk/src/unit_display.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/unit_display.hpp?rev=26777&r1=26776&r2=26777&view=diff
==============================================================================
--- trunk/src/unit_display.hpp (original)
+++ trunk/src/unit_display.hpp Thu May 22 19:40:20 2008
@@ -12,8 +12,10 @@
See the COPYING file for more details.
*/
-//! @file unit_display.hpp
-//! Display units performing various actions: moving, attacking, and dying.
+/**
+ * @file unit_display.hpp
+ * Display units performing various actions: moving, attacking, and dying.
+ */
#ifndef UNIT_DISPLAY_HPP_INCLUDED
#define UNIT_DISPLAY_HPP_INCLUDED
@@ -25,33 +27,45 @@
class unit;
class unit_map;
-//! Contains a number of free functions which display units
-//! performing various on-screen actions - moving, attacking, and dying.
+/**
+ * Contains a number of free functions which display units
+ *
+ * performing various on-screen actions - moving, attacking, and dying.
+ */
namespace unit_display
{
bool unit_visible_on_path( const std::vector<gamemap::location>& path, const
unit& u, const unit_map& units, const std::vector<team>& teams);
-//! Display a unit moving along a given path.
+/** Display a unit moving along a given path. */
void move_unit(const std::vector<gamemap::location>& path, unit& u, const
std::vector<team>& teams);
-//! Show a unit fading out.
-//! Note: this only shows the effect, it doesn't actually kill the unit.
+/**
+ * Show a unit fading out.
+ *
+ * Note: this only shows the effect, it doesn't actually kill the unit.
+ */
void unit_die( const gamemap::location& loc, unit& u, const attack_type*
attack=NULL, const attack_type*secondary_attack=NULL, unit * winner=NULL);
-//! Make the unit on tile 'a' attack the unit on tile 'b'.
-//! The 'damage' will be subtracted from the unit's hitpoints,
-//! and a die effect will be displayed if the unit dies.
-//! @retval true if the defending unit is dead,
-//! and should be removed from the playing field.
+/**
+ * Make the unit on tile 'a' attack the unit on tile 'b'.
+ *
+ * The 'damage' will be subtracted from the unit's hitpoints,
+ * and a die effect will be displayed if the unit dies.
+ *
+ * @retval true if the defending unit is dead, should be
+ * removed from the playing field.
+ */
void unit_attack(
const gamemap::location& a, const gamemap::location& b, int
damage,
const attack_type& attack, const attack_type*
secondary_attack,
int swing,std::string hit_text,bool drain,std::string
att_text);
void unit_recruited(gamemap::location& loc);
-
-//! Set healer_loc to an invalid location if there are no healers.
-//! This will use a poisoning anim if healing<0.
+/**
+ * Set healer_loc to an invalid location if there are no healers.
+ *
+ * This will use a poisoning anim if healing<0.
+ */
void unit_healing(unit& healed,gamemap::location& healed_loc,
std::vector<unit_map::iterator> healers, int healing);
}
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
