doxygen, comments

This commit is contained in:
Hans Joachim Gurt 2007-08-27 05:07:07 +00:00
parent ecea9fbad7
commit 9dd8da4ba4
2 changed files with 12 additions and 6 deletions

View File

@ -12,9 +12,11 @@
See the COPYING file for more details. See the COPYING file for more details.
*/ */
//! @file unit_frame.cpp
//!
#include "global.hpp" #include "global.hpp"
//note: global.hpp must be first! // NOTE: global.hpp must be first!
#include "display.hpp" #include "display.hpp"
#define UNIT_FRAME_H_PART2 #define UNIT_FRAME_H_PART2
@ -108,7 +110,7 @@ const T progressive_<T>::get_current_element(int current_time) const
} }
if(sub_halo >= data_.size()) { if(sub_halo >= data_.size()) {
sub_halo = data_.size(); sub_halo = data_.size();
time = current_time; // never more than max allowed time = current_time; // Never more than max allowed
} }
const T first = data_[sub_halo].first.first; const T first = data_[sub_halo].first.first;

View File

@ -10,7 +10,11 @@
but WITHOUT ANY WARRANTY. but WITHOUT ANY WARRANTY.
See the COPYING file for more details. See the COPYING file for more details.
*/ */
//! @file unit_frame.hpp
//! Frame for unit's animation sequence.
#ifndef UNIT_FRAME_H_INCLUDED #ifndef UNIT_FRAME_H_INCLUDED
#define UNIT_FRAME_H_INCLUDED #define UNIT_FRAME_H_INCLUDED
@ -50,14 +54,14 @@ typedef progressive_<int> progressive_int;
typedef progressive_<double> progressive_double; typedef progressive_<double> progressive_double;
#endif #endif
//This hack prevents MSVC++ 6 to issue several warnings // This hack prevents MSVC++ 6 to issue several warnings
#ifndef UNIT_FRAME_H_PART2 #ifndef UNIT_FRAME_H_PART2
#define UNIT_FRAME_H_PART2 #define UNIT_FRAME_H_PART2
//a class to describe a unit's animation sequence //! Describe a unit's animation sequence.
class unit_frame { class unit_frame {
public: public:
// constructors // Constructors
unit_frame(); unit_frame();
explicit unit_frame(const image::locator& image, int duration=0, explicit unit_frame(const image::locator& image, int duration=0,
const std::string& highlight="1.0",const std::string& offset="", const std::string& highlight="1.0",const std::string& offset="",