chiark / gitweb /
Fiddle with playing.tmpl a bit. not fully translated
[disorder] / lib / log-impl.h
index 27f0004a9615cddb489e062899be8480ad06b42a..d42cec48344731ce7860491dbb2d8e1d805fd94f 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder.
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005 Richard Kettlewell
+ * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
  * 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;
 
 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);
 }
 
   exitfn(EXIT_FAILURE);
 }
 
+/** @brief Log an error */
 void disorder_error(int errno_value, const char *msg, ...) {
   va_list ap;
 
 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);
 }
 
   va_end(ap);
 }
 
+/** @brief Log an informational message */
 void disorder_info(const char *msg, ...) {
   va_list ap;
 
 void disorder_info(const char *msg, ...) {
   va_list ap;
 
@@ -50,4 +58,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
 comment-column:40
 End:
 */
-/* arch-tag:e499f9971df6553a14994bb186235869 */