X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace2%2Fversion.h;h=d7b2822a9ef789db0452524358989c30200af627;hb=2671dfad32dfd51f43560dc19d69dc0b54f3cd2a;hp=1a15af439fb8f304ff1c5ffe39f2bcb506cd060a;hpb=78deb9134e34490c8d90825d7f4778f86b96aa73;p=babeltrace.git diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h index 1a15af43..d7b2822a 100644 --- a/include/babeltrace2/version.h +++ b/include/babeltrace2/version.h @@ -31,10 +31,105 @@ extern "C" { #endif +/*! +@defgroup api-version Library version + +@brief + Library version getters. + +This module contains four functions to get the four parts of the +library's version: + +
-pre5
or -rc1
.
+
+@returns
+ Development stage of the library's version, or \c NULL if none.
+*/
+extern const char *bt_version_get_development_stage(void);
+
+/*!
+@brief
+ Returns libbabeltrace2's version name.
+
+If the version name is not available, which can be the case for a
+development build, this function returns \c NULL.
+
+@returns
+ Library's version name, or \c NULL if not available.
+
+@sa bt_version_get_name_description() —
+ Returns the description of libbabeltrace2's version name.
+*/
+extern const char *bt_version_get_name(void);
+
+/*!
+@brief
+ Returns libbabeltrace2's version name's description.
+
+If the version name's description is not available, which can be the
+case for a development build, this function returns \c NULL.
+
+@returns
+ Library's version name's description, or \c NULL if not available.
+
+@sa bt_version_get_name() —
+ Returns libbabeltrace2's version name.
+*/
+extern const char *bt_version_get_name_description(void);
+
+/*! @} */
#ifdef __cplusplus
}