X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcerrno.h;h=c00e9af02c3bd2d24fb7ca77251f10be022107fd;hb=dd4cdae3e1defc28876d80da99b77c8db1ac0376;hp=f4760d8a861b2a146aa69371bd6faa4b8a411987;hpb=c83c0ac17babbc8b3f4bb82dab2cfeb03065d867;p=runtime.git

diff --git a/lib/silcutil/silcerrno.h b/lib/silcutil/silcerrno.h
index f4760d8a..c00e9af0 100644
--- a/lib/silcutil/silcerrno.h
+++ b/lib/silcutil/silcerrno.h
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SILC Errno
+/****h* silcutil/Errno Interface
  *
  * DESCRIPTION
  *
@@ -53,7 +53,7 @@
 #ifndef SILCERRNO_H
 #define SILCERRNO_H
 
-/****d* silcutil/SilcErrnoAPI/SilcResult
+/****d* silcutil/SilcResult
  *
  * NAME
  *
@@ -140,7 +140,7 @@ typedef enum {
 } SilcResult;
 /***/
 
-/****d* silcutil/SilcErrnoAPI/silc_errno
+/****d* silcutil/silc_errno
  *
  * NAME
  *
@@ -154,7 +154,7 @@ typedef enum {
  ***/
 #define silc_errno silc_get_errno()
 
-/****f* silcutil/SilcErrnoAPI/silc_errno_string
+/****f* silcutil/silc_errno_string
  *
  * NAME
  *
@@ -168,7 +168,7 @@ typedef enum {
  ***/
 const char *silc_errno_string(SilcResult error);
 
-/****d* silcutil/SilcErrnoAPI/silc_errno_string
+/****d* silcutil/silc_errno_reason
  *
  * NAME
  *
@@ -185,22 +185,76 @@ const char *silc_errno_reason(void);
 
 /* Low-level routines for the error handling. */
 
-/* Return last error */
-SilcResult silc_get_errno(void);
-
-/* Set error */
+/****d* silcutil/silc_set_errno
+ *
+ * NAME
+ *
+ *    void silc_set_errno(SilcResult error);
+ *
+ * DESCRIPTION
+ *
+ *    A low level routine to set the error for current thread.
+ *
+ ***/
 void silc_set_errno(SilcResult error);
 
-/* Set error, cannot fail. */
+/****d* silcutil/silc_set_errno_nofail
+ *
+ * NAME
+ *
+ *    void silc_set_errno_nofail(SilcResult error);
+ *
+ * DESCRIPTION
+ *
+ *    A low level routine to set the error for current thread.  This call
+ *    itself cannot cause setting of errno.
+ *
+ ***/
 void silc_set_errno_nofail(SilcResult error);
 
-/* Set error and reason string. */
+/****d* silcutil/silc_set_errno_reason
+ *
+ * NAME
+ *
+ *    void silc_set_errno_reason(SilcResult error, const char *format, ...);
+ *
+ * DESCRIPTION
+ *
+ *    A low level routine to set the error reason for current thread.
+ *
+ ***/
 void silc_set_errno_reason(SilcResult error, const char *format, ...);
 
-/* Set error and reason string, cannot fail. */
+/****d* silcutil/silc_set_errno_reason_nofail
+ *
+ * NAME
+ *
+ *    void silc_set_errno_reason_nofail(SilcResult error,
+ *                                      const char *format, ...);
+ *
+ * DESCRIPTION
+ *
+ *    A low level routine to set the error reason for current thread.  This
+ *    call itself cannot cause setting of errno.
+ *
+ ***/
 void silc_set_errno_reason_nofail(SilcResult error, const char *format, ...);
 
-/* Set error from POSIX errno */
+/****d* silcutil/silc_set_errno_posix
+ *
+ * NAME
+ *
+ *    void silc_set_errno_posix(int error);
+ *
+ * DESCRIPTION
+ *
+ *    A low level routine to set the error for current thread from POSIX
+ *    errno.
+ *
+ ***/
 void silc_set_errno_posix(int error);
 
+/* Return last error */
+SilcResult silc_get_errno(void);
+
 #endif /* SILCERRNO_H */