From: Adam Dickmeiss <adam@indexdata.dk>
Date: Mon, 17 Nov 2008 23:02:10 +0000 (+0100)
Subject: Document yaz_version
X-Git-Tag: v3.0.40~55
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=3185557b9c4f422e12f79a930a89a35b4cac6cfe;p=yaz-moved-to-github.git

Document yaz_version
---

diff --git a/include/yaz/yaz-version.h.in b/include/yaz/yaz-version.h.in
index e6a6bd0..f90ca9a 100644
--- a/include/yaz/yaz-version.h.in
+++ b/include/yaz/yaz-version.h.in
@@ -52,6 +52,18 @@
 
 YAZ_BEGIN_CDECL
 
+/** \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