From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 15 Nov 2021 20:35:25 +0000 (+0100)
Subject: error.h: Document the error code enumeration.
X-Git-Tag: v0.7.0~15
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=e65afce0dd0b070ea03ae778fef54e7c3d477d15

error.h: Document the error code enumeration.

Doxygen complains about the missing comment.
---

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