X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=error.h;h=e94821212fb6ecb0c46fbfa5230a04f5b2295b88;hb=2bad70d84e763b4d866d7b97dbc1cdc8e030bd45;hp=c1e7b9735a0ecc09d959814618eb96345eaa490d;hpb=8181748ed84ac1e7d48ede7c00c9559263683791;p=paraslash.git

diff --git a/error.h b/error.h
index c1e7b973..e9482121 100644
--- a/error.h
+++ b/error.h
@@ -252,6 +252,14 @@
  * 'E_') and gets later redefined to expand to the error text only
  */
 #define PARA_ERROR(err, msg) E_ ## err
+/**
+ * Numeric error codes.
+ *
+ * Public functions which can fail return the negated value of one of the
+ * constants defined here to indicate the cause of the error.
+ *
+ * \sa \ref para_strerror().
+ */
 enum para_error_codes {PARA_ERRORS};
 #undef PARA_ERROR
 #define PARA_ERROR(err, msg) msg