Synopsis only has required headers, since doxygen already output the function
summary. HTML only has 2 small changes for better man page readability:
the Synopsis lines are manonly (had to do that to get SYNOPSIS over to cc 1).
Signed-off-by: Duncan Roe <duncan_roe@xxxxxxxxxxxxxxx>
---
src/extra/pktbuff.c | 45 +++++++++++++++++++++++++++++++++++++++++----
1 file changed, 41 insertions(+), 4 deletions(-)
diff --git a/src/extra/pktbuff.c b/src/extra/pktbuff.c
index 9bdc6bd..8e9a8c7 100644
--- a/src/extra/pktbuff.c
+++ b/src/extra/pktbuff.c
@@ -23,8 +23,21 @@
/**
* \defgroup pktbuff User-space network packet buffer
*
- * This library provides the user-space network packet buffer. This abstraction
- * is strongly inspired by Linux kernel network buffer, the so-called sk_buff.
+ * These functions provide the user-space network packet buffer.
+ * This abstraction is strongly inspired by Linux kernel network buffer,
+ * the so-called sk_buff.
+ *
+ * \manonly
+.RE
+.RS -7
+.nf
+\fBSYNOPSIS
+.RE
+#include <stdint.h>
+#include <stdbool.h>
+#include <sys/socket.h>
+#include <libnetfilter_queue/pktbuff.h>
+\endmanonly
*
* @{
*/
@@ -150,8 +163,20 @@ void pktb_free(struct pkt_buff *pktb)
* \n
* 1. Functions to get values of members of opaque __struct pktbuff__, described
* below
- * \n
+ *
* 2. Internal functions, described in Module __Internal functions__
+ *
+ * \manonly
+.RE
+.RS -7
+.nf
+\fBSYNOPSIS
+.RE
+#include <stdint.h>
+#include <stdbool.h>
+#include <sys/socket.h>
+#include <libnetfilter_queue/pktbuff.h>
+\endmanonly
*
* @{
*/
@@ -159,11 +184,23 @@ void pktb_free(struct pkt_buff *pktb)
/**
* \defgroup uselessfns Internal functions
*
- * \warning Do not use these functions. Instead, always use the mangle
+ * Do not use these functions. Instead, always use the mangle
* function appropriate to the level at which you are working.
* \n
* pktb_mangle() uses all the below functions except _pktb_pull_, which is not
* used by anything.
+ *
+ * \manonly
+.RE
+.RS -7
+.nf
+\fBSYNOPSIS
+.RE
+#include <stdint.h>
+#include <stdbool.h>
+#include <sys/socket.h>
+#include <libnetfilter_queue/pktbuff.h>
+\endmanonly
*
* @{
*/
--
2.17.5
