lib: add bt_version_get_name() and bt_version_get_name_description()

[babeltrace.git] / include / babeltrace2 / version.h

diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h
index 7cd0213f9b62952d297d4a3a679fd241f6cc18df..dc2604bff20bea1e7ec513d5242f3f0c551328f0 100644 (file)
--- a/include/babeltrace2/version.h
+++ b/include/babeltrace2/version.h
@@ -53,6 +53,9 @@ library's version:
   <dt>Extra information</dt>
   <dd>bt_version_get_extra()</dd>
 </dl>
+
+You can also get the version's name and description if available with
+bt_version_get_name() and bt_version_get_name_description().
 */
 
 /*! @{ */
@@ -92,15 +95,39 @@ This extra information can contain a version suffix such as
 <code>-pre5</code> or <code>-rc1</code>.
 
 @returns
-    @parblock
-    Extra information about the library's version.
+    Extra information about the library's version, or \c NULL if none.
+*/
+extern const char *bt_version_get_extra(void);
 
-    Cannot be \c NULL.
+/*!
+@brief
+    Returns libbabeltrace2's version name.
 
-    Can be an empty string if there's no extra information.
-    @endparblock
+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() &mdash;
+    Returns the description of libbabeltrace2's version name.
 */
-extern const char *bt_version_get_extra(void);
+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() &mdash;
+    Returns libbabeltrace2's version name.
+*/
+extern const char *bt_version_get_name_description(void);
 
 /*! @} */