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/log.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/log.h')
| -rw-r--r-- | include/log.h | 14 |
1 files changed, 14 insertions, 0 deletions
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 |