error.h: Document the error code enumeration.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 15 Nov 2021 20:35:25 +0000 (21:35 +0100)
committerAndre Noll <maan@tuebingen.mpg.de>
Sat, 20 Nov 2021 11:04:10 +0000 (12:04 +0100)
Doxygen complains about the missing comment.

error.h

diff --git a/error.h b/error.h
index c1e7b97..e948212 100644 (file)
--- a/error.h
+++ b/error.h
  * '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