X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fyaz-version.h.in;h=da6c22c7b2248f341446855448bc542268449798;hb=76f5f8bd7124c8643be25e0d9838e5897e19df8a;hp=a56cc0a5fc2dcafcb0afb7995e2890ca40486318;hpb=6c24a7636cfb5c6609061e8f4bb696ad8f1607d1;p=yaz-moved-to-github.git

diff --git a/include/yaz/yaz-version.h.in b/include/yaz/yaz-version.h.in
index a56cc0a..da6c22c 100644
--- a/include/yaz/yaz-version.h.in
+++ b/include/yaz/yaz-version.h.in
@@ -32,25 +32,33 @@
 
 #include <yaz/yconfig.h>
 
+/** \brief YAZ version as string */
 #define YAZ_VERSION "@VERSION@"
+
+/** \brief YAZ version as integer (for comparison purposes) */
 #define YAZ_VERSIONL 0x@YAZ_VERSION_HEX@
 
+/** \brief YAZ file version for YAZ DLL (resource) */
 #define YAZ_FILEVERSION @WIN_FILEVERSION@
 
-#define YAZ_DATE 1
-
-
-#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