X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/460b9539a7c15580e41a71bbc0f47ae776238915..22f6160352ba22bd2e759dba6a91c311e0641fc7:/lib/log-impl.h

diff --git a/lib/log-impl.h b/lib/log-impl.h
index 27f0004..b0147a6 100644
--- a/lib/log-impl.h
+++ b/lib/log-impl.h
@@ -17,7 +17,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/log-impl.h @brief Errors and logging */
 
+/** @brief Log an error and quit
+ *
+ * If @c ${DISORDER_FATAL_ABORT} is defined (as anything) then the process
+ * is aborted, so you can get a backtrace.
+ */
 void disorder_fatal(int errno_value, const char *msg, ...) {
   va_list ap;
 
@@ -28,6 +34,7 @@ void disorder_fatal(int errno_value, const char *msg, ...) {
   exitfn(EXIT_FAILURE);
 }
 
+/** @brief Log an error */
 void disorder_error(int errno_value, const char *msg, ...) {
   va_list ap;
 
@@ -36,6 +43,7 @@ void disorder_error(int errno_value, const char *msg, ...) {
   va_end(ap);
 }
 
+/** @brief Log an informational message */
 void disorder_info(const char *msg, ...) {
   va_list ap;
 
@@ -50,4 +58,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
-/* arch-tag:e499f9971df6553a14994bb186235869 */