diff --git a/src/unit_frame.cpp b/src/unit_frame.cpp index 2ea9dc13a0c..837d73bc276 100644 --- a/src/unit_frame.cpp +++ b/src/unit_frame.cpp @@ -12,9 +12,11 @@ See the COPYING file for more details. */ +//! @file unit_frame.cpp +//! #include "global.hpp" -//note: global.hpp must be first! +// NOTE: global.hpp must be first! #include "display.hpp" #define UNIT_FRAME_H_PART2 @@ -108,7 +110,7 @@ const T progressive_::get_current_element(int current_time) const } if(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; diff --git a/src/unit_frame.hpp b/src/unit_frame.hpp index 8e3f3167652..e40cd1d7426 100644 --- a/src/unit_frame.hpp +++ b/src/unit_frame.hpp @@ -10,7 +10,11 @@ but WITHOUT ANY WARRANTY. See the COPYING file for more details. - */ +*/ + +//! @file unit_frame.hpp +//! Frame for unit's animation sequence. + #ifndef UNIT_FRAME_H_INCLUDED #define UNIT_FRAME_H_INCLUDED @@ -50,14 +54,14 @@ typedef progressive_ progressive_int; typedef progressive_ progressive_double; #endif -//This hack prevents MSVC++ 6 to issue several warnings +// This hack prevents MSVC++ 6 to issue several warnings #ifndef 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 { public: - // constructors + // Constructors unit_frame(); explicit unit_frame(const image::locator& image, int duration=0, const std::string& highlight="1.0",const std::string& offset="",