Doxygen: Add @since markers.

[libsigrok.git] / version.c

diff --git a/version.c b/version.c
index 51f344bdd8b05e9860d980c8554272b72c7534a9..c9889f82bb45b1884e0dcdead48e1cfab042a159 100644 (file)
--- a/version.c
+++ b/version.c
@@ -31,44 +31,114 @@
  *
  * Version number querying functions, definitions, and macros.
  *
+ * This set of API calls returns two different version numbers related
+ * to libsigrok. The "package version" is the release version number of the
+ * libsigrok tarball in the usual "major.minor.micro" format, e.g. "0.1.0".
+ *
+ * The "library version" is independent of that; it is the libtool version
+ * number in the "current:revision:age" format, e.g. "2:0:0".
+ * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.
+ *
+ * Both version numbers (and/or individual components of them) can be
+ * retrieved via the API calls at runtime, and/or they can be checked at
+ * compile/preprocessor time using the respective macros.
+ *
  * @{
  */
 
+/**
+ * Get the major libsigrok package version number.
+ *
+ * @return The major package version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_package_version_major_get(void)
 {
        return SR_PACKAGE_VERSION_MAJOR;
 }
 
+/**
+ * Get the minor libsigrok package version number.
+ *
+ * @return The minor package version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_package_version_minor_get(void)
 {
        return SR_PACKAGE_VERSION_MINOR;
 }
 
+/**
+ * Get the micro libsigrok package version number.
+ *
+ * @return The micro package version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_package_version_micro_get(void)
 {
        return SR_PACKAGE_VERSION_MICRO;
 }
 
+/**
+ * Get the libsigrok package version number as a string.
+ *
+ * @return The package version number string. The returned string is
+ *         static and thus should NOT be free'd by the caller.
+ *
+ * @since 0.1.0
+ */
 SR_API const char *sr_package_version_string_get(void)
 {
        return SR_PACKAGE_VERSION_STRING;
 }
 
+/**
+ * Get the "current" part of the libsigrok library version number.
+ *
+ * @return The "current" library version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_lib_version_current_get(void)
 {
        return SR_LIB_VERSION_CURRENT;
 }
 
+/**
+ * Get the "revision" part of the libsigrok library version number.
+ *
+ * @return The "revision" library version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_lib_version_revision_get(void)
 {
        return SR_LIB_VERSION_REVISION;
 }
 
+/**
+ * Get the "age" part of the libsigrok library version number.
+ *
+ * @return The "age" library version number.
+ *
+ * @since 0.1.0
+ */
 SR_API int sr_lib_version_age_get(void)
 {
        return SR_LIB_VERSION_AGE;
 }
 
+/**
+ * Get the libsigrok library version number as a string.
+ *
+ * @return The library version number string. The returned string is
+ *         static and thus should NOT be free'd by the caller.
+ *
+ * @since 0.1.0
+ */
 SR_API const char *sr_lib_version_string_get(void)
 {
        return SR_LIB_VERSION_STRING;