diff options
author | Duncan Roe <duncan_roe@optusnet.com.au> | 2019-10-27 19:49:06 +1100 |
---|---|---|
committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2019-11-04 18:24:44 +0100 |
commit | e46569cd8583fd0ed4ed20fc51ff7e2b875c2d11 (patch) | |
tree | c6cd0beed37ebd9133e7eafec8db174042536777 /src/libnfnetlink.c | |
parent | 5087de4556d1367fad54b3ea1cd38a770a15995c (diff) |
Minimally resurrect doxygen documentation
The documentation was written in the days before doxygen required groups or even
doxygen.cfg, so create doxygen.cfg.in and introduce one \defgroup per source
file, encompassing pretty-much the whole file.
Also add a tiny \mainpage.
Added:
doxygen.cfg.in: Same as for libmnl except FILE_PATTERNS = *.c libnfnetlink.h
Updated:
configure.ac: Create doxygen.cfg
src/iftable.c: Add defgroup
src/libnfnetlink.c: Add mainpage and defgroup
Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
Diffstat (limited to 'src/libnfnetlink.c')
-rw-r--r-- | src/libnfnetlink.c | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/src/libnfnetlink.c b/src/libnfnetlink.c index df57533..3db21e0 100644 --- a/src/libnfnetlink.c +++ b/src/libnfnetlink.c @@ -52,6 +52,18 @@ #include <libnfnetlink/libnfnetlink.h> +/** + * \mainpage + * + * libnfnetlink is the bottom-level communication between the kernel and + * userspace + */ + +/** + * \defgroup libnfnetlink Functions in libnfnetlink.c + * @{ + */ + #ifndef NETLINK_ADD_MEMBERSHIP #define NETLINK_ADD_MEMBERSHIP 1 #endif @@ -60,7 +72,6 @@ #define SOL_NETLINK 270 #endif - #define nfnl_error(format, args...) \ fprintf(stderr, "%s: " format "\n", __FUNCTION__, ## args) @@ -1572,3 +1583,7 @@ int nfnl_query(struct nfnl_handle *h, struct nlmsghdr *nlh) return nfnl_catch(h); } + +/** + * @} + */ |