diff options
| author | Thomas Graf <tgraf@redhat.com> | 2012-11-08 01:29:12 +0100 |
|---|---|---|
| committer | Thomas Graf <tgraf@redhat.com> | 2012-11-08 01:29:12 +0100 |
| commit | b132ee7e27899b07f30e9a53dd6ce5f09efd8bf6 (patch) | |
| tree | d57dcd99500ea9adc54b90bea3b051041ad02f14 /doc | |
| parent | a721c1d445c0cd8c1d555821e5a5e62e77006a87 (diff) | |
| download | libnl-b132ee7e27899b07f30e9a53dd6ce5f09efd8bf6.tar.gz | |
nl: improve API doc of transmit functions
Signed-off-by: Thomas Graf <tgraf@redhat.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 4 | ||||
| -rw-r--r-- | doc/DoxygenLayout.xml | 1 | ||||
| -rw-r--r-- | doc/src/hidden.c | 7 |
3 files changed, 10 insertions, 2 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index c43d7642..7a0640c0 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -198,7 +198,9 @@ ALIASES = arg=\param \ "ref_core{2}=\ref_asciidoc{core,\1,\2 (Netlink Core Library Development Guide)}" \ "ref_route{2}=\ref_asciidoc{route,\1,\2 (Netlink Routing Development Guide)}" \ "core_doc{2}=\ref_core{\1,\2}" \ - "route_doc{2}=\ref_route{\1,\2}" + "route_doc{2}=\ref_route{\1,\2}" \ + "callback=\par Callback Invocation:\n" \ + "lowlevel=\copydoc low_level_api" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 8d3e3ff8..680d3da3 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -18,7 +18,6 @@ <tab type="files" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="dirs" visible="no" title="" intro=""/> <tab type="examples" visible="yes" title="" intro=""/> </navindex> diff --git a/doc/src/hidden.c b/doc/src/hidden.c index be4a042b..a63621d7 100644 --- a/doc/src/hidden.c +++ b/doc/src/hidden.c @@ -32,4 +32,11 @@ accessor function is provided solely for the purpose of creating objects for comparison and filtering. +\page low_level_api Low Level API + +\note This is a low level API function. A high level function implementing + the same functionality with a simplified usage pattern exists. This + function is available as an alternative if the default library + behaviour is not desirable. + */ |