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/tcp.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/tcp.c')
| -rw-r--r-- | src/extra/tcp.c | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/extra/tcp.c b/src/extra/tcp.c index 01bfe8c..720afd2 100644 --- a/src/extra/tcp.c +++ b/src/extra/tcp.c @@ -29,6 +29,15 @@ /** * \defgroup tcp TCP helper functions + * + * \manonly +.SH SYNOPSIS +.nf +\fB +#include <libmnl/libmnl.h> +#include <libnetfilter_queue/libnetfilter_queue_tcp.h> +\endmanonly + * * @{ */ @@ -92,6 +101,17 @@ unsigned int nfq_tcp_get_payload_len(struct tcphdr *tcph, struct pkt_buff *pktb) * * Most user-space programs will never need these. * + * + * \manonly +.SH SYNOPSIS +.nf +\fB +#include <netinet/ip.h> +#include <netinet/ip6.h> +#include <netinet/tcp.h> +#include <libnetfilter_queue/libnetfilter_queue_tcp.h> +\endmanonly + * * @{ */ |