summaryrefslogtreecommitdiffstats
path: root/crawl-ref/source/version.h
diff options
context:
space:
mode:
authorNeil Moore <neil@s-z.org>2014-05-29 16:37:21 -0400
committerNeil Moore <neil@s-z.org>2014-05-29 16:39:37 -0400
commitddcb950fa10637df34187a0611e68c943ca31285 (patch)
treea3ef09dc4389d1229766111e097874d51855b136 /crawl-ref/source/version.h
parent408c133e4b347784b614e0518905a3cb8bfe5f30 (diff)
downloadcrawl-ref-ddcb950fa10637df34187a0611e68c943ca31285.tar.gz
crawl-ref-ddcb950fa10637df34187a0611e68c943ca31285.zip
Be more consistent with doxygen comment style.
Use /** for block comments, /// for short comments, and /**< and ///< for post-member comments. The //<! that appeared in a few places wasn't even correct: it should have been //!< (but is now ///<).
Diffstat (limited to 'crawl-ref/source/version.h')
-rw-r--r--crawl-ref/source/version.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/crawl-ref/source/version.h b/crawl-ref/source/version.h
index 5b576365d2..8952853dde 100644
--- a/crawl-ref/source/version.h
+++ b/crawl-ref/source/version.h
@@ -17,16 +17,16 @@ enum rel_type
namespace Version
{
- //! The major version string.
- /*!
+ /// The major version string.
+ /**
* This version is just the major release number, e.g. '0.10' for
* all of 0.10-a0, 0.10, and 0.10.1 (assuming this last is even
* released).
*/
extern const char* Major;
- //! The short version string.
- /*!
+ /// The short version string.
+ /**
* This version will generally match the last version tag. For instance,
* if the last tag of Crawl before this build was '0.1.2', you'd see
* '0.1.2'. This version number does not include some rather important
@@ -36,8 +36,8 @@ namespace Version
*/
extern const char* Short;
- //! The long version string.
- /*!
+ /// The long version string.
+ /**
* This string contains detailed version information about the CrissCross
* build in use. The string will always start with the Git tag that this
* build descended from. If this build is not an exact match for a given
@@ -46,8 +46,8 @@ namespace Version
*/
extern const char* Long;
- //! The release type.
- /*!
+ /// The release type.
+ /**
* Indicates whether it's a devel or a stable version.
*/
extern const rel_type ReleaseType;