summaryrefslogtreecommitdiffstats
path: root/src/config.c
diff options
context:
space:
mode:
authorDetlev Casanova <detlev.casanova@gmail.com>2010-08-06 20:59:09 +0200
committerDetlev Casanova <detlev.casanova@gmail.com>2010-08-06 20:59:09 +0200
commitf10d3965967d581676beb4c9e529b72dbfb4c672 (patch)
tree331f674cead2ba137e034c17bfdc64d034df8fb3 /src/config.c
parenta3ac6869831b8cce7cd0f738019a0acc2271cbb8 (diff)
downloadlayman-f10d3965967d581676beb4c9e529b72dbfb4c672.tar.gz
layman-f10d3965967d581676beb4c9e529b72dbfb4c672.tar.bz2
layman-f10d3965967d581676beb4c9e529b72dbfb4c672.zip
Add proper Doxygen documentation + it's generated HTML output.
Diffstat (limited to 'src/config.c')
-rw-r--r--src/config.c23
1 files changed, 22 insertions, 1 deletions
diff --git a/src/config.c b/src/config.c
index eed3b7e..c578d90 100644
--- a/src/config.c
+++ b/src/config.c
@@ -3,13 +3,32 @@
#include "config.h"
#include "internal.h"
+/**
+ * \internal
+ */
#define debug(x) printf(x)
+/** \defgroup config Config
+ * \brief Layman library configuration module
+ */
+
+/** \addtogroup config
+ * @{
+ */
+
+
+/**
+ * \internal
+ */
struct BareConfig
{
PyObject *object;
};
+/**
+ * \internal
+ * Returns the internal Python object.
+ */
PyObject *_bareConfigObject(BareConfig *c)
{
if (c && c->object)
@@ -71,7 +90,7 @@ void bareConfigFree(BareConfig* cfg)
free(cfg);
}
-/*
+/**
* Get an option's default value.
*
* \param opt the name of the option
@@ -141,3 +160,5 @@ int bareConfigSetOptionValue(BareConfig* cfg, const char* opt, const char* val)
return ret;
}
+
+/** @} */