More doc comments

[disorder] / lib / log.h

diff --git a/lib/log.h b/lib/log.h
index 5d39732d7f2996adadd6b4a395af7f22fc837191..ecabd30f8a7ffd9779ad6a16f6ab5d4392aab743 100644 (file)
--- a/lib/log.h
+++ b/lib/log.h
@@ -69,6 +69,11 @@ extern const char *debug_filename;
 extern int debug_lineno;
 extern int logdate;
 
+/** @brief Issue a debug message if debugging is turned on
+ * @param x Parenthesized debug arguments
+ *
+ * Use in the format: D(("format string", arg, arg, ...));
+ */
 #define D(x) do {                              \
   if(debugging) {                              \
     debug_filename=__FILE__;                   \