mail[Wesnoth-commits] r27264 - in /trunk/src: pathutils.cpp pathutils.hpp


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by koraq on June 17, 2008 - 20:54:
Author: mordante
Date: Tue Jun 17 20:10:51 2008
New Revision: 27264

URL: http://svn.gna.org/viewcvs/wesnoth?rev=27264&view=rev
Log:
Update doxygen comment style.

Modified:
    trunk/src/pathutils.cpp
    trunk/src/pathutils.hpp

Modified: trunk/src/pathutils.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/pathutils.cpp?rev=27264&r1=27263&r2=27264&view=diff
==============================================================================
--- trunk/src/pathutils.cpp (original)
+++ trunk/src/pathutils.cpp Tue Jun 17 20:10:51 2008
@@ -12,8 +12,10 @@
    See the COPYING file for more details.
 */
 
-//! @file pathutils.cpp
-//! Various pathfinding functions and utilities.
+/**
+ * @file pathutils.cpp
+ * Various pathfinding functions and utilities.
+ */
 
 #include "global.hpp"
 

Modified: trunk/src/pathutils.hpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/pathutils.hpp?rev=27264&r1=27263&r2=27264&view=diff
==============================================================================
--- trunk/src/pathutils.hpp (original)
+++ trunk/src/pathutils.hpp Tue Jun 17 20:10:51 2008
@@ -12,33 +12,39 @@
 See the COPYING file for more details.
 */
 
-//! @file pathutils.hpp
-//!
+/** @file pathutils.hpp */
 
 #ifndef PATHUTILS_H_INCLUDED
 #define PATHUTILS_H_INCLUDED
 
 #include "map.hpp"
 
-//! Function which tells if two locations are adjacent.
+/** Function which tells if two locations are adjacent. */
 bool tiles_adjacent(const gamemap::location& a, const gamemap::location& b);
 
-//! Function which, given a location, will place all adjacent locations in 
res.
-//! res must point to an array of 6 location objects.
+/**
+ * Function which, given a location, will place all adjacent locations in 
res.
+ * res must point to an array of 6 location objects.
+ */
 void get_adjacent_tiles(const gamemap::location& a, gamemap::location* res);
 
-
-//! Function which, given a location, will place all locations in a ring of
-//! distance r in res. res must be a std::vector of location
+/**
+ * Function which, given a location, will place all locations in a ring of
+ * distance r in res. res must be a std::vector of location
+ */
 void get_tile_ring(const gamemap::location& a, const int r, 
std::vector<gamemap::location>& res);
 
-//! Function which, given a location, will place all locations in the radius 
of r in res
-//! res must be a std::vector of location
+/**
+ * Function which, given a location, will place all locations in the radius 
of r in res
+ * res must be a std::vector of location
+ */
 void get_tiles_in_radius(const gamemap::location& a, const int r, 
std::vector<gamemap::location>& res);
 
-//! Function which gives the number of hexes between two tiles
-//! (i.e. the minimum number of hexes that have to be traversed
-//! to get from one hex to the other).
+/**
+ * Function which gives the number of hexes between two tiles
+ * (i.e. the minimum number of hexes that have to be traversed
+ * to get from one hex to the other).
+ */
 size_t distance_between(const gamemap::location& a, const gamemap::location& 
b);
 
 #endif




Related Messages


Powered by MHonArc, Updated Tue Jun 17 21:42:25 2008