diff options
author | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 01:25:48 +0200 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 01:25:48 +0200 |
commit | a6d8f4bb835dc01344861e26b78867273322cb52 (patch) | |
tree | 36c4cea88536c8015563abf2991d8313966af229 /include/plugin.h | |
parent | b5fc727db22139bb3f28367d1f31f241ccc1e236 (diff) | |
download | connman-a6d8f4bb835dc01344861e26b78867273322cb52.tar.gz connman-a6d8f4bb835dc01344861e26b78867273322cb52.tar.bz2 connman-a6d8f4bb835dc01344861e26b78867273322cb52.zip |
First steps into providing API documentation
Diffstat (limited to 'include/plugin.h')
-rw-r--r-- | include/plugin.h | 18 |
1 files changed, 17 insertions, 1 deletions
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 \ }; |