Bring CHANGES.html up to date

[disorder] / lib / log-impl.h

diff --git a/lib/log-impl.h b/lib/log-impl.h
index 51577df9d13750dd522b902bcfe62b730aa03efd..de47cf2730ebcda677cc8678323165a7ec4f4b34 100644 (file)
--- a/lib/log-impl.h
+++ b/lib/log-impl.h
@@ -1,23 +1,27 @@
 /*
  * 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
+ * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+/** @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 +32,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 +41,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;