X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace2%2Fversion.h;h=7cd0213f9b62952d297d4a3a679fd241f6cc18df;hb=43c59509042845f8d42c3e99ec74d45fa2dc0908;hp=7138e94e9a896fddb54ae1f21975b6f58301a10a;hpb=924dc299c8a893e92fcd985fa05c245b591ef314;p=babeltrace.git

diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h
index 7138e94e..7cd0213f 100644
--- 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
@@ -23,15 +23,87 @@
  * SOFTWARE.
  */
 
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
+
 #ifdef __cplusplus
 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>
+*/
+
+/*! @{ */
+
+/*!
+@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
+    @parblock
+    Extra information about the library's version.
+
+    Cannot be \c NULL.
+
+    Can be an empty string if there's no extra information.
+    @endparblock
+*/
 extern const char *bt_version_get_extra(void);
 
+/*! @} */
+
 #ifdef __cplusplus
 }
 #endif