From 215a590bbd7604d5a35109dbff2afadcbecaeabd Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sun, 29 Dec 2013 04:29:33 +0000 Subject: [PATCH] Some documentation on versioning information. --- doc/guide/version.hpp | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doc/guide/version.hpp diff --git a/doc/guide/version.hpp b/doc/guide/version.hpp new file mode 100644 index 0000000000..3a669f7ada --- /dev/null +++ b/doc/guide/version.hpp @@ -0,0 +1,29 @@ +/*! @page timer mlpack version information + +@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): + +@code +__MLPACK_VERSION_MAJOR +__MLPACK_VERSION_MINOR +__MLPACK_VERSION_PATCH +@endcode + +In addition, the function \c mlpack::util::GetVersion() returns the mlpack +version as a string (for instance, "mlpack 1.0.8"). + +@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"). + +*/