diff options
| author | Thomas Graf <tgraf@redhat.com> | 2012-05-10 10:03:59 (GMT) |
|---|---|---|
| committer | Thomas Graf <tgraf@redhat.com> | 2012-05-10 10:03:59 (GMT) |
| commit | fec10a282355def49133e63b8a4591cc51b46478 (patch) | |
| tree | 68995f7b253397edfe7ba0511c14a9b1bf85a911 /lib/utils.c | |
| parent | 32057bc15469e6f012841605daa38766497fa196 (diff) | |
| download | libnl-fec10a282355def49133e63b8a4591cc51b46478.zip libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.gz libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.bz2 | |
doc: documentation restructuring
- changes the modules hierarchy to better represent the set of libaries
- list the header file that needs to be included
- remove examples/doc from api ref that is included in the guide
- add references to the guide
- fix doxygen api linking for version 1.8.0
- readd doxygen mainpage to config file
- fix a couple of doxygen doc bugs
Diffstat (limited to 'lib/utils.c')
| -rw-r--r-- | lib/utils.c | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/lib/utils.c b/lib/utils.c index 83d424f..5a35a53 100644 --- a/lib/utils.c +++ b/lib/utils.c @@ -6,13 +6,22 @@ * License as published by the Free Software Foundation version 2.1 * of the License. * - * Copyright (c) 2003-2008 Thomas Graf <tgraf@suug.ch> + * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch> */ /** * @ingroup core * @defgroup utils Utilities + * + * Collection of helper functions + * * @{ + * + * Header + * ------ + * ~~~~{.c} + * #include <netlink/utils.h> + * ~~~~ */ #include <netlink-local.h> @@ -21,10 +30,24 @@ #include <linux/socket.h> /** - * Debug level + * Global variable indicating the desired level of debugging output. + * + * Level | Messages Printed + * ----- | --------------------------------------------------------- + * 0 | Debugging output disabled + * 1 | Warnings, important events and notifications + * 2 | More or less important debugging messages + * 3 | Repetitive events causing a flood of debugging messages + * 4 | Even less important messages + * + * If available, the variable will be initialized to the value of the + * environment variable `NLDBG`. The default value is 0 (disabled). + * + * For more information, see section @core_doc{_debugging, Debugging}. */ int nl_debug = 0; +/** @cond SKIP */ struct nl_dump_params nl_debug_dp = { .dp_type = NL_DUMP_DETAILS, }; @@ -84,9 +107,10 @@ int __nl_read_num_str_file(const char *path, int (*cb)(long, const char *)) return 0; } +/** @endcond */ /** - * @name Unit Pretty-Printing + * @name Pretty Printing of Numbers * @{ */ |