docs: Clean up TOC 17/10217/1
authorDave Wallace <dwallacelf@gmail.com>
Tue, 23 Jan 2018 22:47:02 +0000 (17:47 -0500)
committerDave Wallace <dwallacelf@gmail.com>
Wed, 24 Jan 2018 01:23:34 +0000 (01:23 +0000)
Change-Id: I5415c002a431d84372f56d4a77dc2aabd6ef55f7
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit 1eb970d16028e9a987c1dd2bfe217d1313262b81)

doxygen/user_doc.md
extras/libmemif/src/libmemif.h
extras/vcl-ldpreload/README.md
src/plugins/kubeproxy/kp_plugin_doc.md

index f7d7936..7ac81e1 100644 (file)
@@ -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
index 796d121..f5df79c 100644 (file)
@@ -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
  *
  * @{
  */
index e9026c1..b40c4c5 100644 (file)
@@ -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.
 
index e124791..0d3cc0d 100644 (file)
@@ -1,4 +1,4 @@
-# Kube-proxy plugin for VPP
+# Kube-proxy plugin for VPP    {#kp_plugin_doc}
 
 ## Overview