[mlpack-svn] r16091 - mlpack/trunk/doc/guide

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: Sat Dec 28 23:29:33 2013
New Revision: 16091

Log:
Some documentation on versioning information.


Added:
   mlpack/trunk/doc/guide/version.hpp

Added: mlpack/trunk/doc/guide/version.hpp
==============================================================================
--- (empty file)
+++ mlpack/trunk/doc/guide/version.hpp	Sat Dec 28 23:29:33 2013
@@ -0,0 +1,29 @@
+/*! @page timer mlpack version information
+
+ at section vercode mlpack versions in code
+
+mlpack provides a couple of convenience macros and functions to get the version
+of mlpack.  More information (and straightforward code) can be found in
+src/mlpack/core/util/version.hpp.
+
+The following three macros provide major, minor, and patch versions of mlpack
+(i.e. for mlpack-x.y.z, 'x' is the major version, 'y' is the minor version, and
+'z' is the patch version):
+
+ at code
+__MLPACK_VERSION_MAJOR
+__MLPACK_VERSION_MINOR
+__MLPACK_VERSION_PATCH
+ at endcode
+
+In addition, the function \c mlpack::util::GetVersion() returns the mlpack
+version as a string (for instance, "mlpack 1.0.8").
+
+ at section verex mlpack executable versions
+
+Each mlpack executable supports the \c --version (or \c -V ) option, which will
+print the version of mlpack used.  If the version is not an official release but
+instead from svn trunk, the version will be "mlpack trunk" (and may have a
+revision number appended to "trunk").
+
+*/