diff options
author | Duncan Roe <duncan_roe@optusnet.com.au> | 2021-08-13 14:44:36 +1000 |
---|---|---|
committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2021-08-15 14:06:42 +0200 |
commit | bd7189f6fbe6648f5e61ca9aa1169ebaf846adde (patch) | |
tree | 2f698c960d721ab64526e7e590dc9f273f2a40b4 /src/extra/ipv4.c | |
parent | 50b3846c1ea49580a6d2f6f68c98a3ffa2d75f88 (diff) |
src: doc: Insert SYNOPSIS sections for man pages
In order to work with the post-processing logic in doxygen/Makefile.am,
SYNOPSIS sections must be inserted at the end of the module description
(text after \defgroup or \addtogroup)
(becomes Detailed Description in the man page).
Also a few minor updates including rename module uselessfns to do_not_use.
Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
Diffstat (limited to 'src/extra/ipv4.c')
-rw-r--r-- | src/extra/ipv4.c | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/src/extra/ipv4.c b/src/extra/ipv4.c index af4482d..58fb471 100644 --- a/src/extra/ipv4.c +++ b/src/extra/ipv4.c @@ -23,6 +23,15 @@ /** * \defgroup ipv4 IPv4 helper functions + * + * \manonly +.SH SYNOPSIS +.nf +\fB +#include <libmnl/libmnl.h> +#include <libnetfilter_queue/libnetfilter_queue_ipv4.h> +\endmanonly + * * @{ */ @@ -88,6 +97,15 @@ int nfq_ip_set_transport_header(struct pkt_buff *pktb, struct iphdr *iph) * * Most user-space programs will never need these. * + * + * \manonly +.SH SYNOPSIS +.nf +\fB +#include <libmnl/libmnl.h> +#include <libnetfilter_queue/libnetfilter_queue_ipv4.h> +\endmanonly + * * @{ */ @@ -143,7 +161,7 @@ int nfq_ip_mangle(struct pkt_buff *pktb, unsigned int dataoff, } /** - * nfq_pkt_snprintf_ip - print IPv4 header into buffer in iptables LOG format + * nfq_ip_snprintf - print IPv4 header into buffer in iptables LOG format * \param buf: Pointer to buffer that will be used to print the header * \param size: Size of the buffer (or remaining room in it) * \param iph: Pointer to a valid IPv4 header |