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 ++++++++++++++
 include/plugin.h | 18 +++++++++++++++++-
 2 files changed, 31 insertions(+), 1 deletion(-)

(limited to 'include')

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
diff --git a/include/plugin.h b/include/plugin.h
index 387a48c0..427ceede 100644
--- a/include/plugin.h
+++ b/include/plugin.h
@@ -26,6 +26,12 @@
 extern "C" {
 #endif
 
+/**
+ * SECTION:plugin
+ * @title: Plugin premitives
+ * @short_description: Functions for declaring plugins
+ */
+
 struct connman_plugin_desc {
 	const char *name;
 	const char *description;
@@ -34,7 +40,17 @@ struct connman_plugin_desc {
 	void (*exit) (void);
 };
 
-#define CONNMAN_PLUGIN_DEFINE(name,description,version,init,exit) \
+/**
+ * CONNMAN_PLUGIN_DEFINE:
+ * @name: plugin name
+ * @description: plugin description
+ * @version: plugin version string
+ * @init: init function called on plugin loading
+ * @exit: exit function called on plugin removal
+ *
+ * Macro for defining a plugin descriptor
+ */
+#define CONNMAN_PLUGIN_DEFINE(name, description, version, init, exit) \
 		struct connman_plugin_desc connman_plugin_desc = { \
 			name, description, version, init, exit \
 		};
-- 
cgit v1.2.3