error.h: Document the error code enumeration.

[paraslash.git] / error.h

diff --git a/error.h b/error.h
index c1e7b9735a0ecc09d959814618eb96345eaa490d..e94821212fb6ecb0c46fbfa5230a04f5b2295b88 100644 (file)
--- 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