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 87eea513495368e51c3ee588b54477f00cf40923..64154d11270b1e1aeaf747fcd965dcfb9fc95592 100644 (file)
--- a/lib/eventlog.h
+++ b/lib/eventlog.h
@@ -21,23 +21,46 @@
 #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)));
 
-void eventlog_remove(struct eventlog_output *lo);
-/* remove a log output */
+/** @brief Remove an event log output
+ * @param lo Pointer to output to remove
+ */
+void eventlog_remove(struct eventlog_output *lo) attribute((nonnull(1)));
+
+/** @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 */