Document yaz_errno utils

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

diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h
index d63bd27..901b118 100644 (file)
--- a/include/yaz/nmem.h
+++ b/include/yaz/nmem.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2007, Index Data
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2009 Index Data.
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -24,7 +24,6 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/* $Id: nmem.h,v 1.26 2007-11-14 21:03:59 adam Exp $ */
 
 /**
  * \file
@@ -125,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
@@ -135,6 +146,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab