Author: hajo
Date: Wed Aug 22 01:34:34 2007
New Revision: 19713
URL: http://svn.gna.org/viewcvs/wesnoth?rev=19713&view=rev
Log:
doxygen, comments
Modified:
trunk/src/animated.hpp
trunk/src/animated.i
Modified: trunk/src/animated.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/animated.hpp?rev=19713&r1=19712&r2=19713&view=diff
==============================================================================
--- trunk/src/animated.hpp (original)
+++ trunk/src/animated.hpp Wed Aug 22 01:34:34 2007
@@ -11,6 +11,9 @@
See the COPYING file for more details.
*/
+
+//! @file animated.hpp
+//! Animate units.
#ifndef ANIMATED_IMAGE_H_INCLUDED
#define ANIMATED_IMAGE_H_INCLUDED
@@ -44,11 +47,12 @@
animated(const std::vector<frame_description> &cfg, int start_time =
0,bool force_change =false);
- // Adds a frame
+ //! 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, double
acceleration=1);
int get_begin_time() const;
@@ -57,14 +61,15 @@
void update_last_draw_time();
bool need_update() const;
- //True if the current animation was finished
+ //! Returns true if the current animation was finished.
bool animation_finished() const;
bool animation_would_finish() const;
int get_animation_time() const;
- //For the moment, all the following functions dont't use (or
incorrectly) acceleration
+
+ //! @todo For the moment, all the following functions dont't use (or
incorrectly use) acceleration
const int get_animation_duration() const;
const T& get_current_frame() const;
- // get the next frame (or the current + shift frames)
+ //! Get the next frame (or the current + shift frames)
const T& get_next_frame(int shift = 1) const;
const int get_current_frame_begin_time() const;
const int get_current_frame_end_time() const;
@@ -97,11 +102,11 @@
int start_time_;
};
- bool does_not_change_; // optimization for 1-frame permanent animations
+ bool does_not_change_; // Optimization for 1-frame permanent animations
bool started_;
std::vector<frame> frames_;
- //these are only valid when anim is started
+ // These are only valid when anim is started
int start_tick_; // time at which we started
bool cycles_;
double acceleration_;
Modified: trunk/src/animated.i
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/animated.i?rev=19713&r1=19712&r2=19713&view=diff
==============================================================================
--- trunk/src/animated.i (original)
+++ trunk/src/animated.i Wed Aug 22 01:34:34 2007
@@ -11,7 +11,10 @@
but WITHOUT ANY WARRANTY.
See the COPYING file for more details.
- */
+*/
+
+//! @file animated.i
+//! Templates related to animations.
#include "global.hpp"
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
