mail[Wesnoth-commits] r27455 - /trunk/src/animated.hpp


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

Header


Content

Posted by koraq on June 23, 2008 - 22:04:
Author: mordante
Date: Mon Jun 23 21:48:12 2008
New Revision: 27455

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

Modified:
    trunk/src/animated.hpp

Modified: trunk/src/animated.hpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/animated.hpp?rev=27455&r1=27454&r2=27455&view=diff
==============================================================================
--- trunk/src/animated.hpp (original)
+++ trunk/src/animated.hpp Mon Jun 23 21:48:12 2008
@@ -12,8 +12,10 @@
    See the COPYING file for more details.
 */
 
-//! @file animated.hpp
-//! Animate units.
+/**
+ * @file animated.hpp
+ * Animate units.
+ */
 
 #ifndef ANIMATED_IMAGE_H_INCLUDED
 #define ANIMATED_IMAGE_H_INCLUDED
@@ -47,12 +49,15 @@
        animated(const std::vector<frame_description> &cfg, int start_time = 
0,bool force_change =false);
 
 
-       //! Adds a frame to an animation.
+       /** Adds a frame to an animation. */
        void add_frame(int duration, const T& value,bool force_change =false);
 
-       //! Starts an animation cycle.
-       //! The first frame of the animation to start may be set
-       //! to any value by using a start_time different to 0.
+       /**
+        * Starts an animation cycle.
+        *
+        * The first frame of the animation to start may be set to any value 
by
+        * using a start_time different to 0.
+        */
        void start_animation(int start_time, bool cycles=false);
        void pause_animation(){ started_ =false;};
        void restart_animation(){if(start_tick_) started_ = true;};
@@ -69,7 +74,7 @@
 
        bool cycles() const {return cycles_;};
 
-       //! Returns true if the current animation was finished.
+       /** Returns true if the current animation was finished. */
        bool animation_finished() const;
        bool animation_finished_potential() const;
        int get_animation_time() const;




Related Messages


Powered by MHonArc, Updated Mon Jun 23 22:21:45 2008