From f10d3965967d581676beb4c9e529b72dbfb4c672 Mon Sep 17 00:00:00 2001 From: Detlev Casanova Date: Fri, 6 Aug 2010 20:59:09 +0200 Subject: Add proper Doxygen documentation + it's generated HTML output. --- doc/html/group__config.html | 238 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 doc/html/group__config.html (limited to 'doc/html/group__config.html') diff --git a/doc/html/group__config.html b/doc/html/group__config.html new file mode 100644 index 0000000..674695e --- /dev/null +++ b/doc/html/group__config.html @@ -0,0 +1,238 @@ + + +C-Layman: Config + + + + + +
+

Config

Layman library configuration module. +More... +

+ + + + + + + + + + + + + + + + + + +

Data Structures

struct  BareConfig

Functions

PyObject * _bareConfigObject (BareConfig *c)
BareConfig * bareConfigCreate (Message *m, FILE *outFd, FILE *inFd, FILE *errFd)
void bareConfigFree (BareConfig *cfg)
const char * bareConfigGetDefaultValue (BareConfig *cfg, const char *opt)
const char * bareConfigGetOptionValue (BareConfig *cfg, const char *opt)
int bareConfigSetOptionValue (BareConfig *cfg, const char *opt, const char *val)
+

Detailed Description

+Layman library configuration module.

Function Documentation

+ +
+
+ + + + + + + + + +
PyObject* _bareConfigObject (BareConfig *  c  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BareConfig* bareConfigCreate (Message *  m,
FILE *  outFd,
FILE *  inFd,
FILE *  errFd 
)
+
+
+ +

+Creates a bare config object with default values.

+

Parameters:
+ + + + +
outFd where information must be written to
inFd where information must be read from
errFd where errors must be written to
+
+
Returns:
a new instance of a BareConfig object. It must be freed with bareConfigFree()
+ +
+

+ +

+
+ + + + + + + + + +
void bareConfigFree (BareConfig *  cfg  ) 
+
+
+ +

+Frees a BareConfig object. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
const char* bareConfigGetDefaultValue (BareConfig *  cfg,
const char *  opt 
)
+
+
+ +

+Get an option's default value.

+

Parameters:
+ + +
opt the name of the option
+
+
Returns:
the value or NULL on failure.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
const char* bareConfigGetOptionValue (BareConfig *  cfg,
const char *  opt 
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int bareConfigSetOptionValue (BareConfig *  cfg,
const char *  opt,
const char *  val 
)
+
+
+ +

+ +

+

+

+
Generated on Fri Aug 6 20:00:53 2010 for C-Layman by  + +doxygen 1.5.8
+ + -- cgit v1.2.3-1-g7c22