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__message.html | 449 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 449 insertions(+) create mode 100644 doc/html/group__message.html (limited to 'doc/html/group__message.html') diff --git a/doc/html/group__message.html b/doc/html/group__message.html new file mode 100644 index 0000000..ffe8be9 --- /dev/null +++ b/doc/html/group__message.html @@ -0,0 +1,449 @@ + + +C-Layman: Message + + + + + +
+

Message

Debug message management. +More... +

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

Data Structures

struct  Message

Functions

Message * messageCreate (const char *module, FILE *out, FILE *err, FILE *dbg)
int messageSetDebugLevel (Message *m, int debug_level)
int messageSetDebugVerbosity (Message *m, int debug_verbosity)
int messageSetInfoLevel (Message *m, int info_level)
int messageSetWarnLevel (Message *m, int warn_level)
int messageSetColorsOn (Message *m)
int messageSetColorsOff (Message *m)
int messageSetDebugMethods (Message *m, const char *mth)
int messageSetDebugClasses (Message *m, const char *cla)
int messageSetDebugVariables (Message *m, const char *var)
void messageFree (Message *m)
PyObject * _messageObject (Message *m)
+

Detailed Description

+Debug message management. +

+This class relays all debug messages to the given files and set different debug levels.

Function Documentation

+ +
+
+ + + + + + + + + +
PyObject* _messageObject (Message *  m  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Message* messageCreate (const char *  module,
FILE *  out,
FILE *  err,
FILE *  dbg 
)
+
+
+ +

+Creates a Message instance with default values. To modify those values, use the corresponding functions.

+

Parameters:
+ + + + + +
module the module to debug. If you don't know, set "layman"
out where to write info
err where to write errors
dbg where to write debug information
+
+
Returns:
a new instance of a Message object. It must be freed with messageFree()
+ +
+

+ +

+
+ + + + + + + + + +
void messageFree (Message *  m  ) 
+
+
+ +

+Frees a message structure. +

+

+ +

+
+ + + + + + + + + +
int messageSetColorsOff (Message *  m  ) 
+
+
+ +

+Deactivates colors in the output

+

Returns:
1 on success, 0 on failure
+ +
+

+ +

+
+ + + + + + + + + +
int messageSetColorsOn (Message *  m  ) 
+
+
+ +

+Activates colors in the output

+

Returns:
1 on success, 0 on failure
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetDebugClasses (Message *  m,
const char *  cla 
)
+
+
+ +

+Sets the classes to be debugged.

+

Parameters:
+ + +
mth the list of classes to be debugged, separated by comas
+
+
Returns:
1 on success, 0 on failure
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetDebugLevel (Message *  m,
int  debug_level 
)
+
+
+ +

+Set the debug level.

+

Parameters:
+ + +
debug_level the debug level
+
+
Returns:
True on success, False on failure.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetDebugMethods (Message *  m,
const char *  mth 
)
+
+
+ +

+Sets the methods to be debugged.

+

Parameters:
+ + +
mth the list of methods to be debugged, separated by comas
+
+
Returns:
1 on success, 0 on failure
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetDebugVariables (Message *  m,
const char *  var 
)
+
+
+ +

+Sets the variables to be debugged.

+

Parameters:
+ + +
mth the list of variables to be debugged, separated by comas
+
+
Returns:
1 on success, 0 on failure
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetDebugVerbosity (Message *  m,
int  debug_verbosity 
)
+
+
+ +

+Set the debug verbosity.

+

Parameters:
+ + +
debug_verbosity the debug verbosity
+
+
Returns:
True on success, False on failure.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetInfoLevel (Message *  m,
int  info_level 
)
+
+
+ +

+Set the info level.

+

Parameters:
+ + +
info_level the info level
+
+
Returns:
True on success, False on failure.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int messageSetWarnLevel (Message *  m,
int  warn_level 
)
+
+
+ +

+Set the warning level.

+

Parameters:
+ + +
warn_level the warning level
+
+
Returns:
True on success, False on failure.
+ +
+

+

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