upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-04-27 09:18:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doxygen comment style.

Browse Source
This commit is contained in:
Mark de Wever 2008-09-21 11:33:57 +00:00
parent f862641af8
commit 1314296615
1 changed files with 69 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
src/version.hpp
View File

@ -18,27 +18,29 @@
#include <string>
#include <vector>
//! @file version.hpp
//! Interfaces for manipulating version numbers of engine,
//! add-ons, etc.
//!
//! This class assumes versions are in the format "X.Y.Z", with
//! additional components not being associated to canonical
//! names.
//!
/**
* @file version.hpp
* Interfaces for manipulating version numbers of engine,
* add-ons, etc.
*
* This class assumes versions are in the format "X.Y.Z", with
* additional components not being associated to canonical
* names.
*/
class version_info
{
public:
struct not_sane_exception {};
version_info(); //!< Default constructor.
version_info(const version_info&); //!< Copy constructor.
version_info(const std::string&); //!< String constructor.
//! Simple list constructor.
version_info(); /**< Default constructor. */
version_info(const version_info&); /**< Copy constructor. */
version_info(const std::string&); /**< String constructor. */
/** Simple list constructor. */
version_info(unsigned int major, unsigned int minor, unsigned int revision_level, bool sane,
char special_separator='\0', const std::string& special=std::string());
//! Assignment operator.
/** Assignment operator. */
version_info& operator=(const version_info& o) {
this->assign(o);
return *this;
@ -55,74 +57,85 @@ public:
// Canonical version components.
unsigned int major_version() const; //!< Retrieves the major version number (X in "X.Y.Z").
unsigned int minor_version() const; //!< Retrieves the minor version number (Y in "X.Y.Z").
unsigned int revision_level() const; //!< Retrieves the revision level (Z in "X.Y.Z").
unsigned int major_version() const; /**< Retrieves the major version number (X in "X.Y.Z"). */
unsigned int minor_version() const; /**< Retrieves the minor version number (Y in "X.Y.Z"). */
unsigned int revision_level() const; /**< Retrieves the revision level (Z in "X.Y.Z"). */
//! It is sometimes useful so append special build/distribution
//! information to version numbers, in the form of "X.Y.Z+svn",
//! "X.Y.Za", etcetera. This member function retrieves such if
//! available.
/**
* It is sometimes useful so append special build/distribution
* information to version numbers, in the form of "X.Y.Z+svn",
* "X.Y.Za", etcetera. This member function retrieves such if
* available.
*/
const std::string& special_version() const {
return this->special_;
}
//! Retrieves the special version separator. For the "X.Y.Z+blah"
//! string, it would be '+'. On the other hand, it would be a null
//! (ASCII 00) character if the string was "X.Y.Za".
/**
* Retrieves the special version separator. For the "X.Y.Z+blah"
* string, it would be '+'. On the other hand, it would be a null
* (ASCII 00) character if the string was "X.Y.Za".
*/
char special_version_separator() const {
return this->special_separator_;
}
void set_major_version(unsigned int); //!< Set major version number.
void set_minor_version(unsigned int); //!< Set minor version number.
void set_revision_level(unsigned int); //!< Set revision level.
void set_major_version(unsigned int); /**< Set major version number. */
void set_minor_version(unsigned int); /**< Set minor version number. */
void set_revision_level(unsigned int); /**< Set revision level. */
//! Set special version string.
/** Set special version string. */
void set_special_version(const std::string& str) {
this->special_ = str;
}
// Non-canonical version strings components.
//! Returns a component from a non-canonically formatted
//! version string (i.e. 'D' from A.B.C.D is index 3).
//! The index may be in the [0,3) range; in such case, this
//! function works identically to the canonical version
//! numbers extractors.
//!
//! @note If the number of components is smaller than index-1,
//! a std::out_of_range exception may be thrown.
/**
* Returns a component from a non-canonically formatted
* version string (i.e. 'D' from A.B.C.D is index 3).
* The index may be in the [0,3) range; in such case, this
* function works identically to the canonical version
* numbers extractors.
*
* @note If the number of components is smaller than index-1,
* a std::out_of_range exception may be thrown.
*/
unsigned int get_component(size_t index) const {
return nums_.at(index);
}
//! Sets a component in a non-canonically formatted
//! version string (i.e. 'D' from A.B.C.D is index 3).
//! The index may be in the [0,3) range; in such case, this
//! function works identically to the canonical version
//! numbers setters.
//!
//! @note If the number of components is smaller than index-1,
//! new ones are added and initialized as 0 to make room.
/**
* Sets a component in a non-canonically formatted
* version string (i.e. 'D' from A.B.C.D is index 3).
* The index may be in the [0,3) range; in such case, this
* function works identically to the canonical version
* numbers setters.
*
* @note If the number of components is smaller than index-1,
* new ones are added and initialized as 0 to make room.
*/
void set_component(size_t index, unsigned int value) {
nums_.at(index) = value;
}
//! Read-only access to complete vector of components.
/** Read-only access to complete vector of components. */
const std::vector<unsigned int>& components() const {
return this->nums_;
}
std::string str() const; //!< Returns a formatted string of the form A.B.C[.x1[.x2[...]]]kS,
//!< where xN stand for non-canonical version components, k for the
//!< suffix separator, and S for the suffix string.
std::string str() const; /**<
* Returns a formatted string of the form
* A.B.C[.x1[.x2[...]]]kS, where xN stand for
* non-canonical version components, k for the
* suffix separator, and S for the suffix string.
*/
//! Syntactic shortcut for str().
/** Syntactic shortcut for str(). */
operator std::string() const { return this->str(); }
protected:
//! Assign from other version_info object.
/** Assign from other version_info object. */
void assign(const version_info&);
private:
@ -134,17 +147,17 @@ private:
void init_special_version(const std::string& full_component, std::string& number_string);
};
//! Equality operator for version_info.
/** Equality operator for version_info. */
bool operator==(const version_info&, const version_info&);
//! Inequality operator for version_info.
/** Inequality operator for version_info. */
bool operator!=(const version_info&, const version_info&);
//! Greater-than operator for version_info.
/** Greater-than operator for version_info. */
bool operator>(const version_info&, const version_info&);
//! Less-than operator for version_info.
/** Less-than operator for version_info. */
bool operator<(const version_info&, const version_info&);
//! Greater-than-or-equal operator for version_info.
/** Greater-than-or-equal operator for version_info. */
bool operator>=(const version_info&, const version_info&);
//! Less-than-or-equal operator for version_info.
/** Less-than-or-equal operator for version_info. */
bool operator<=(const version_info&, const version_info&);
#endif /* !VERSION_HPP_INCLUDED */