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 d1677319551152343f4c0790ad98bb5488539a66..dc2604bff20bea1e7ec513d5242f3f0c551328f0 100644 (file)
--- a/include/babeltrace2/version.h
+++ b/include/babeltrace2/version.h
@@ -2,7 +2,7 @@
 #define BABELTRACE2_VERSION_H
 
 /*
- * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
+ * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -31,11 +31,106 @@
 extern "C" {
 #endif
 
-extern int bt_version_get_major(void);
-extern int bt_version_get_minor(void);
-extern int bt_version_get_patch(void);
+/*!
+@defgroup api-version Library version
+
+@brief
+    Library version getters.
+
+This module contains four functions to get the four parts of 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>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().
+*/
+
+/*! @{ */
+
+/*!
+@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 extra information about the version of libbabeltrace2.
+
+This extra information can contain a version suffix such as
+<code>-pre5</code> or <code>-rc1</code>.
+
+@returns
+    Extra information about the library's version, or \c NULL if none.
+*/
 extern const char *bt_version_get_extra(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() &mdash;
+    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() &mdash;
+    Returns libbabeltrace2's version name.
+*/
+extern const char *bt_version_get_name_description(void);
+
+/*! @} */
+
 #ifdef __cplusplus
 }
 #endif