Renamed AC var YAZ_VERSION_HEX to VERSION_HEX

[yaz-moved-to-github.git] / include / yaz / yaz-version.h.in

diff --git a/include/yaz/yaz-version.h.in b/include/yaz/yaz-version.h.in
index d5ed578..e440a8f 100644 (file)
--- a/include/yaz/yaz-version.h.in
+++ b/include/yaz/yaz-version.h.in
@@ -32,25 +32,33 @@
 
 #include <yaz/yconfig.h>
 
-#define YAZ_VERSION "3.0.38"
-#define YAZ_VERSIONL 0x030026
+/** \brief YAZ version as string */
+#define YAZ_VERSION "@VERSION@"
 
-#define YAZ_FILEVERSION 3,0,38,1
+/** \brief YAZ version as integer (for comparison purposes) */
+#define YAZ_VERSIONL 0x@VERSION_HEX@
 
-#define YAZ_DATE 1
+/** \brief YAZ file version for YAZ DLL (resource) */
+#define YAZ_FILEVERSION @WIN_FILEVERSION@
 
-
-#ifdef WIN32
-#ifdef NDEBUG
-#define YAZ_OS "WIN32 Release"
-#else
-#define YAZ_OS "WIN32 Debug"
-#endif
-#endif
+/** \brief SHA1 ID for YAZ (Git) */
+#define YAZ_VERSION_SHA1 "@VERSION_SHA1@"
 
 YAZ_BEGIN_CDECL
 
-YAZ_EXPORT unsigned long yaz_version(char *version_str, char *sys_str);
+/** \brief returns YAZ version
+    \param version_str holds version upon completion (YAZ_VERSION)
+    \param sha1_str holds SHA1 (Git) upon completion (YAZ_VERSION_SHA1)
+    \returns long version value (YAZ_VERSIONL)
+
+    The version_str may be NULL in which case version is not returned.
+    When not-null, version_str, should point to a buffer of at least 20
+    charcters in size (including "\0").
+    The sha1_str may be NULL in which case the SHA1 is not returnd.
+    When not-null, sha1_str whould point to a buffer of at least 41 characters
+    in size (including "\0"). 
+  */
+YAZ_EXPORT unsigned long yaz_version(char *version_str, char *sha1_str);
 
 YAZ_END_CDECL