summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Wallace <dwallacelf@gmail.com>2018-01-23 17:47:02 -0500
committerDave Wallace <dwallacelf@gmail.com>2018-01-23 17:47:02 -0500
commit1eb970d16028e9a987c1dd2bfe217d1313262b81 (patch)
treeb1f10f2c15effb969ad0d1519d01ce52b3c3895f
parent1539400f141df74ae301c8e911fcd3fef7a61b2e (diff)
docs: Clean up TOC
Change-Id: I5415c002a431d84372f56d4a77dc2aabd6ef55f7 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
-rw-r--r--doxygen/user_doc.md2
-rw-r--r--extras/libmemif/src/libmemif.h10
-rw-r--r--extras/vcl-ldpreload/README.md2
-rw-r--r--src/plugins/kubeproxy/kp_plugin_doc.md2
4 files changed, 12 insertions, 4 deletions
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
index f7d7936b3f3..7ac81e109ce 100644
--- a/doxygen/user_doc.md
+++ b/doxygen/user_doc.md
@@ -17,3 +17,5 @@ Several modules provide operational, dataplane-user focused documentation.
- @subpage srv6_doc
- @subpage srmpls_doc
- @subpage nat64_doc
+- @subpage vcl_ldpreload_doc
+- @subpage kp_plugin_doc
diff --git a/extras/libmemif/src/libmemif.h b/extras/libmemif/src/libmemif.h
index 796d1212ef9..f5df79c9c69 100644
--- a/extras/libmemif/src/libmemif.h
+++ b/extras/libmemif/src/libmemif.h
@@ -15,7 +15,9 @@
*------------------------------------------------------------------
*/
-/** @file */
+/** @file
+ * @defgroup libmemif
+ */
#ifndef _LIBMEMIF_H_
#define _LIBMEMIF_H_
@@ -78,7 +80,7 @@ typedef enum
/**
* @defgroup MEMIF_FD_EVENT Types of events that need to be watched for specific fd.
- *
+ * @ingroup libmemif
* @{
*/
@@ -99,6 +101,7 @@ typedef enum
typedef void *memif_conn_handle_t;
/**
* @defgroup CALLBACKS Callback functions definitions
+ * @ingroup libmemif
*
* @{
*/
@@ -135,6 +138,7 @@ typedef int (memif_interrupt_t) (memif_conn_handle_t conn, void *private_ctx,
/**
* @defgroup ARGS_N_BUFS Connection arguments and buffers
+ * @ingroup libmemif
*
* @{
*/
@@ -193,6 +197,7 @@ typedef struct
/**
* @defgroup MEMIF_DETAILS Memif details structs
+ * @ingroup libmemif
*
* @{
*/
@@ -256,6 +261,7 @@ typedef struct
/**
* @defgroup API_CALLS Api calls
+ * @ingroup libmemif
*
* @{
*/
diff --git a/extras/vcl-ldpreload/README.md b/extras/vcl-ldpreload/README.md
index e9026c1aae5..b40c4c5ad07 100644
--- a/extras/vcl-ldpreload/README.md
+++ b/extras/vcl-ldpreload/README.md
@@ -1,4 +1,4 @@
-# vcl-ldpreload a LD_PRELOAD library that uses the VPP Communications Library (VCL).
+# vcl-ldpreload: a LD_PRELOAD library that uses the VPP Communications Library (VCL). {#vcl_ldpreload_doc}
User can LD_PRELOAD any application that uses POSIX socket API.
diff --git a/src/plugins/kubeproxy/kp_plugin_doc.md b/src/plugins/kubeproxy/kp_plugin_doc.md
index e1247916bd5..0d3cc0d50ca 100644
--- a/src/plugins/kubeproxy/kp_plugin_doc.md
+++ b/src/plugins/kubeproxy/kp_plugin_doc.md
@@ -1,4 +1,4 @@
-# Kube-proxy plugin for VPP
+# Kube-proxy plugin for VPP {#kp_plugin_doc}
## Overview