X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=version.c;h=8fbbafae1592021f9a9d24838ac2718814a49a38;hp=1f9c98e3d3cea052c1bf9a89906980599cbf8e18;hb=04ff49263b0a462250d2301e6d4d17db5904a8d3;hpb=4895418c6800ecb128ed36af2a1bc46916c9be85

diff --git a/version.c b/version.c
index 1f9c98e..8fbbafa 100644
--- a/version.c
+++ b/version.c
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode project.
  *
- * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,57 +18,128 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "sigrokdecode.h"
+#include "libsigrokdecode.h"
 
 /**
  * @file
  *
- * Version number querying functions.
+ * Version number querying functions, definitions, and macros.
  */
 
 /**
  * @defgroup grp_versions Versions
  *
- * Version number querying functions.
+ * Version number querying functions, definitions, and macros.
+ *
+ * This set of API calls returns two different version numbers related
+ * to libsigrokdecode. The "package version" is the release version number
+ * of the libsigrokdecode 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 libsigrokdecode package version number.
+ *
+ * @return The major package version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_package_version_major_get(void)
 {
 	return SRD_PACKAGE_VERSION_MAJOR;
 }
 
+/**
+ * Get the minor libsigrokdecode package version number.
+ *
+ * @return The minor package version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_package_version_minor_get(void)
 {
 	return SRD_PACKAGE_VERSION_MINOR;
 }
 
+/**
+ * Get the micro libsigrokdecode package version number.
+ *
+ * @return The micro package version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_package_version_micro_get(void)
 {
 	return SRD_PACKAGE_VERSION_MICRO;
 }
 
+/**
+ * Get the libsigrokdecode 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
+ */
 SRD_API const char *srd_package_version_string_get(void)
 {
 	return SRD_PACKAGE_VERSION_STRING;
 }
 
+/**
+ * Get the "current" part of the libsigrokdecode library version number.
+ *
+ * @return The "current" library version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_lib_version_current_get(void)
 {
 	return SRD_LIB_VERSION_CURRENT;
 }
 
+/**
+ * Get the "revision" part of the libsigrokdecode library version number.
+ *
+ * @return The "revision" library version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_lib_version_revision_get(void)
 {
 	return SRD_LIB_VERSION_REVISION;
 }
 
+/**
+ * Get the "age" part of the libsigrokdecode library version number.
+ *
+ * @return The "age" library version number.
+ *
+ * @since 0.1.0
+ */
 SRD_API int srd_lib_version_age_get(void)
 {
 	return SRD_LIB_VERSION_AGE;
 }
 
+/**
+ * Get the libsigrokdecode 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
+ */
 SRD_API const char *srd_lib_version_string_get(void)
 {
 	return SRD_LIB_VERSION_STRING;