From: Adam Dickmeiss <adam@indexdata.dk>
Date: Sun, 1 Mar 2009 22:04:09 +0000 (+0100)
Subject: Document yaz_errno utils
X-Git-Tag: v3.0.45~24
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=6cec9293846dc1aba8c0e2f5e46fc029a727f4ed;p=yaz-moved-to-github.git

Document yaz_errno utils
---

diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h
index 6f0d230..901b118 100644
--- a/include/yaz/nmem.h
+++ b/include/yaz/nmem.h
@@ -124,8 +124,20 @@ YAZ_EXPORT void nmem_destroy(NMEM n);
  */
 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 
+/** \brief returns errno 
+    \returns errno value 
+*/
 YAZ_EXPORT int yaz_errno(void);
+
+/** \brief sets errno to value
+    \param v errno value
+*/
 YAZ_EXPORT void yaz_set_errno (int v);
+
+/** \brief returns system error description string
+    \param buf buffer for result
+    \param max maximum number of bytes to store
+*/
 YAZ_EXPORT void yaz_strerror(char *buf, int max);
 
 YAZ_END_CDECL