From a6d8f4bb835dc01344861e26b78867273322cb52 Mon Sep 17 00:00:00 2001
From: Marcel Holtmann <marcel@holtmann.org>
Date: Thu, 14 Aug 2008 01:25:48 +0200
Subject: First steps into providing API documentation

---
 include/log.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'include/log.h')

diff --git a/include/log.h b/include/log.h
index 8a0b5a52..81a5bc4f 100644
--- a/include/log.h
+++ b/include/log.h
@@ -26,10 +26,24 @@
 extern "C" {
 #endif
 
+/**
+ * SECTION:log
+ * @title: Logging premitives
+ * @short_description: Functions for logging error and debug information
+ */
+
 extern void connman_info(const char *format, ...);
 extern void connman_error(const char *format, ...);
 extern void connman_debug(const char *format, ...);
 
+/**
+ * DBG:
+ * @fmt: format string
+ * @arg...: list of arguments
+ *
+ * Simple macro around connman_debug() which also include the function
+ * name it is called in.
+ */
 #define DBG(fmt, arg...) connman_debug("%s:%s() " fmt, __FILE__, __FUNCTION__ , ## arg)
 
 #ifdef __cplusplus
-- 
cgit v1.2.3