mail[Wesnoth-commits] r27469 - in /trunk/src: builder.cpp builder.hpp


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

Header


Content

Posted by koraq on June 24, 2008 - 08:34:
Author: mordante
Date: Tue Jun 24 07:59:54 2008
New Revision: 27469

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

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

Modified: trunk/src/builder.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/builder.cpp?rev=27469&r1=27468&r2=27469&view=diff
==============================================================================
--- trunk/src/builder.cpp (original)
+++ trunk/src/builder.cpp Tue Jun 24 07:59:54 2008
@@ -12,8 +12,10 @@
    See the COPYING file for more details.
 */
 
-//! @file builder.cpp
-//! Terrain builder.
+/**
+ * @file builder.cpp
+ * Terrain builder.
+ */
 
 #include "global.hpp"
 
@@ -212,7 +214,7 @@
        return changed;
 }
 
-//! @todo TODO: rename this function
+/** @todo TODO: rename this function */
 void terrain_builder::rebuild_terrain(const gamemap::location &loc)
 {
        if (tile_map_.on_map(loc)) {

Modified: trunk/src/builder.hpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/builder.hpp?rev=27469&r1=27468&r2=27469&view=diff
==============================================================================
--- trunk/src/builder.hpp (original)
+++ trunk/src/builder.hpp Tue Jun 24 07:59:54 2008
@@ -12,8 +12,10 @@
    See the COPYING file for more details.
 */
 
-//! @file builder.hpp
-//! Definitions for the terrain builder.
+/**
+ * @file builder.hpp
+ * Definitions for the terrain builder.
+ */
 
 #ifndef BUILDER_H_INCLUDED
 #define BUILDER_H_INCLUDED
@@ -42,10 +44,16 @@
 class terrain_builder
 {
 public:
-       //! Used as a parameter for the get_terrain_at function.
+       /** Used as a parameter for the get_terrain_at function. */
        enum ADJACENT_TERRAIN_TYPE {
-                       ADJACENT_BACKGROUND,    //!< Represents terrains 
which are to be drawn behind unit sprites
-                       ADJACENT_FOREGROUND     //!< Represents terrains 
which are to be drawn in front of them.
+                       ADJACENT_BACKGROUND,    /**< 
+                                                                        * 
Represents terrains which are to be
+                                                                        * 
drawn behind unit sprites
+                                                                        */
+                       ADJACENT_FOREGROUND         /**< 
+                                                                        * 
Represents terrains which are to be
+                                                                        * 
drawn in front of them.
+                                                                        */
        };
 
        /** A shorthand typedef for a list of animated image locators,




Related Messages


Powered by MHonArc, Updated Tue Jun 24 08:43:02 2008