Merge branch 'master' of git.distorted.org.uk:~mdw/publish/public-git/disorder

[disorder] / lib / eventlog.h

diff --git a/lib/eventlog.h b/lib/eventlog.h
index 65497960621b966c2148b3c65b69a55bdae27c53..64154d11270b1e1aeaf747fcd965dcfb9fc95592 100644 (file)
--- a/lib/eventlog.h
+++ b/lib/eventlog.h
@@ -2,42 +2,65 @@
  * This file is part of DisOrder
  * Copyright (C) 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/eventlog.h
+ * @brief Event logging
  */
-
 #ifndef EVENTLOG_H
 #define EVENTLOG_H
 
-/* definition of an event log output.  The caller must allocate these
- * (since log.c isn't allowed to perform memory allocation). */
+/** @brief An output for the event log
+ *
+ * The caller must allocate these (since log.c isn't allowed to perform memory
+ * allocation).  They form a linked list, using eventlog_add() and
+ * eventlog_remove().
+ */
 struct eventlog_output {
+  /** @brief Next output */
   struct eventlog_output *next;
+
+  /** @brief Handler for this output */
   void (*fn)(const char *msg, void *user);
+
+  /** @brief Passed to @ref fn */
   void *user;
 };
 
-void eventlog_add(struct eventlog_output *lo);
-/* add a log output */
+/** @brief Add an event log output
+ * @param lo Pointer to output to add
+ */
+void eventlog_add(struct eventlog_output *lo) attribute((nonnull(1)));
+
+/** @brief Remove an event log output
+ * @param lo Pointer to output to remove
+ */
+void eventlog_remove(struct eventlog_output *lo) attribute((nonnull(1)));
 
-void eventlog_remove(struct eventlog_output *lo);
-/* remove a log output */
+/** @brief Send a message to the event log
+ * @param keyword Distinguishing keyword for event
+ * @param ... Extra data, terminated by (char *)0
+ */
+void eventlog(const char *keyword, ...) attribute((nonnull(1)));
 
-void eventlog(const char *keyword, ...);
-void eventlog_raw(const char *keyword, const char *raw, ...);
-/* send a message to the event log */
+/** @brief Send a message to the event log
+ * @param keyword Distinguishing keyword for event
+ * @param raw Unformatted data
+ * @param ... Extra data, terminated by (char *)0
+ */
+void eventlog_raw(const char *keyword, const char *raw, ...)
+  attribute((nonnull(1, 2)));
 
 #endif /* EVENTLOG_H */