X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace2%2Fversion.h;h=a1d27864eb35b2c3996d336cdfe30d0362148043;hp=1558385738d0c16603fb5b076cd0fee6cde76781;hb=a0446fa8710ece12a7b9457e1b0e03ce7e4fc2c4;hpb=0dcb770f6937931cd08a8046fc17b03e54d43aa4

diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h
index 15583857..a1d27864 100644
--- a/include/babeltrace2/version.h
+++ b/include/babeltrace2/version.h
@@ -31,10 +31,179 @@
 extern "C" {
 #endif
 
-extern int bt_version_get_major(void);
-extern int bt_version_get_minor(void);
-extern int bt_version_get_patch(void);
-extern const char *bt_version_get_extra(void);
+/*!
+@defgroup api-version Library version
+
+@brief
+    Library version getters.
+
+This module contains functions to get information about the library's
+version:
+
+<dl>
+  <dt>Major version</dt>
+  <dd>bt_version_get_major()</dd>
+
+  <dt>Minor version</dt>
+  <dd>bt_version_get_minor()</dd>
+
+  <dt>Patch version</dt>
+  <dd>bt_version_get_patch()</dd>
+
+  <dt>\bt_dt_opt Development stage</dt>
+  <dd>bt_version_get_development_stage()</dd>
+
+  <dt>\bt_dt_opt Version control system revision's description</dt>
+  <dd>bt_version_get_vcs_revision_description()</dd>
+
+  <dt>\bt_dt_opt Release name</dt>
+  <dd>bt_version_get_name()</dd>
+
+  <dt>\bt_dt_opt Release name's description</dt>
+  <dd>bt_version_get_name_description()</dd>
+
+  <dt>\bt_dt_opt Extra name</dt>
+  <dd>bt_version_get_extra_name()</dd>
+
+  <dt>\bt_dt_opt Extra description</dt>
+  <dd>bt_version_get_extra_description()</dd>
+
+  <dt>\bt_dt_opt Extra patch names</dt>
+  <dd>bt_version_get_extra_patch_names()</dd>
+</dl>
+*/
+
+/*! @{ */
+
+/*!
+@brief
+    Returns the major version of libbabeltrace2.
+
+@returns
+    Major version of the library.
+*/
+extern unsigned int bt_version_get_major(void);
+
+/*!
+@brief
+    Returns the minor version of libbabeltrace2.
+
+@returns
+    Minor version of the library.
+*/
+extern unsigned int bt_version_get_minor(void);
+
+/*!
+@brief
+    Returns the patch version of libbabeltrace2.
+
+@returns
+    Patch version of the library.
+*/
+extern unsigned int bt_version_get_patch(void);
+
+/*!
+@brief
+    Returns the development stage of libbabeltrace2's version.
+
+The development stage \em can contain a version suffix such as
+<code>-pre5</code> or <code>-rc1</code>.
+
+@returns
+    Development stage of the library's version, or \c NULL if none.
+*/
+extern const char *bt_version_get_development_stage(void);
+
+/*!
+@brief
+    Returns the version control system (VCS) revision's description of
+    libbabeltrace2's version.
+
+The VCS revision description is only available for a non-release build
+of the library.
+
+@returns
+    Version control system revision's description of the library's
+    version, or \c NULL if none.
+*/
+extern const char *bt_version_get_vcs_revision_description(void);
+
+/*!
+@brief
+    Returns libbabeltrace2's release name.
+
+If the release name is not available, which can be the case for a
+development build, this function returns \c NULL.
+
+@returns
+    Library's release name, or \c NULL if not available.
+
+@sa bt_version_get_name_description() &mdash;
+    Returns the description of libbabeltrace2's release name.
+*/
+extern const char *bt_version_get_name(void);
+
+/*!
+@brief
+    Returns libbabeltrace2's release name's description.
+
+If the release name's description is not available, which can be the
+case for a development build, this function returns \c NULL.
+
+@returns
+    Library's release name's description, or \c NULL if not available.
+
+@sa bt_version_get_name() &mdash;
+    Returns libbabeltrace2's release name.
+*/
+extern const char *bt_version_get_name_description(void);
+
+/*!
+@brief
+    Returns the extra name of libbabeltrace2's version.
+
+The extra name of the library's version can be set at build time for a
+custom build.
+
+@returns
+    Library's version extra name, or \c NULL if not available.
+*/
+extern const char *bt_version_get_extra_name(void);
+
+/*!
+@brief
+    Returns the extra description of libbabeltrace2's version.
+
+The extra description of the library's version can be set at build time
+for a custom build.
+
+@returns
+    @parblock
+    Library's version extra description, or \c NULL if not available.
+
+    Can contain newlines.
+    @endparblock
+*/
+extern const char *bt_version_get_extra_description(void);
+
+/*!
+@brief
+    Returns the extra patch names of libbabeltrace2's version.
+
+The extra patch names of the library's version can be set at build time
+for a custom build.
+
+@returns
+    @parblock
+    Library's version extra patch names, or \c NULL if not available.
+
+    Each line of the returned string contains the name of a patch
+    applied to Babeltrace's source tree for a custom build.
+    @endparblock
+*/
+extern const char *bt_version_get_extra_patch_names(void);
+
+/*! @} */
 
 #ifdef __cplusplus
 }