VPP-307 - vnet/vnet/vxlan-gpe Documentation fixes

Change-Id: Icd7b82306f49e8148d5e7b2fccd8b5f1005f935d
Signed-off-by: Keith Burns (alagalah) <alagalah@gmail.com>

diff --git a/vnet/vnet/vxlan-gpe/decap.c b/vnet/vnet/vxlan-gpe/decap.c
index 3720837..315a0a1 100644 (file)
--- a/vnet/vnet/vxlan-gpe/decap.c
+++ b/vnet/vnet/vxlan-gpe/decap.c
@@ -39,10 +39,10 @@ typedef struct {
 /**
  * @brief Tracing function for VXLAN GPE packet decapsulation
  *
- * @param *s - u8 - format string
- * @param *args - va_list - arguments to display
+ * @param *s
+ * @param *args
  *
- * @return *s u8 - formatted trace output
+ * @return *s
  *
  */
 static u8 * format_vxlan_gpe_rx_trace (u8 * s, va_list * args)
@@ -67,10 +67,10 @@ static u8 * format_vxlan_gpe_rx_trace (u8 * s, va_list * args)
 /**
  * @brief Tracing function for VXLAN GPE packet decapsulation including length
  *
- * @param *s - u8 - format string
- * @param *args - va_list - arguments to display
+ * @param *s
+ * @param *args
  *
- * @return *s u8 - formatted trace output
+ * @return *s
  *
  */
 static u8 * format_vxlan_gpe_with_length (u8 * s, va_list * args)
@@ -93,12 +93,12 @@ static u8 * format_vxlan_gpe_with_length (u8 * s, va_list * args)
  *
  *      vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->decap_fib_index;
  *
- * @param *vm - vlib_main_t
- * @param *node - vlib_node_runtime_t
- * @param *from_frame - vlib_frame_t
- * @param ip_ip4 - u8
+ * @param *vm
+ * @param *node
+ * @param *from_frame
+ * @param ip_ip4
  *
- * @return from_frame->n_vectors - uword
+ * @return from_frame->n_vectors
  *
  */
 always_inline uword
@@ -594,11 +594,11 @@ vxlan_gpe_input (vlib_main_t * vm,
  * @brief Graph processing dispatch function for IPv4 VXLAN GPE
  *
  * @node vxlan4-gpe-input
- * @param *vm - vlib_main_t
- * @param *node - vlib_node_runtime_t
- * @param *from_frame - vlib_frame_t
+ * @param *vm
+ * @param *node
+ * @param *from_frame
  *
- * @return from_frame->n_vectors - uword
+ * @return from_frame->n_vectors
  *
  */
 static uword
@@ -612,11 +612,11 @@ vxlan4_gpe_input (vlib_main_t * vm, vlib_node_runtime_t * node,
  * @brief Graph processing dispatch function for IPv6 VXLAN GPE
  *
  * @node vxlan6-gpe-input
- * @param *vm - vlib_main_t
- * @param *node - vlib_node_runtime_t
- * @param *from_frame - vlib_frame_t
+ * @param *vm
+ * @param *node
+ * @param *from_frame
  *
- * @return from_frame->n_vectors - uword
+ * @return from_frame->n_vectors
  *
  */
 static uword

diff --git a/vnet/vnet/vxlan-gpe/encap.c b/vnet/vnet/vxlan-gpe/encap.c
index cf48241..3f6f43c 100644 (file)
--- a/vnet/vnet/vxlan-gpe/encap.c
+++ b/vnet/vnet/vxlan-gpe/encap.c
@@ -67,10 +67,10 @@ typedef struct {
 /**
  * @brief Trace of packets encapsulated in VXLAN GPE
  *
- * @param *s - u8 - formatted string
- * @param *args - va_list
+ * @param *s
+ * @param *args
  *
- * @return *s - u8 - formatted string
+ * @return *s
  *
  */
 u8 * format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
@@ -87,11 +87,11 @@ u8 * format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
 /**
  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup
  *
- * @param *ngm - vxlan_gpe_maint_t
- * @param *b0 - vlib_buffer_t
- * @param *t0 - vxlan_gpe_tunnel_t - contains rewrite header
- * @param *next0 - u32 - relative index of next dispatch function (next node)
- * @param is_v4 - u8 - Is this IPv4? (or IPv6)
+ * @param *ngm
+ * @param *b0
+ * @param *t0 contains rewrite header
+ * @param *next0 relative index of next dispatch function (next node)
+ * @param is_v4 Is this IPv4? (or IPv6)
  *
  */
 always_inline void
@@ -117,14 +117,14 @@ vxlan_gpe_encap_one_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0,
 /**
  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets
  *
- * @param *ngm - vxlan_gpe_maint_t
- * @param *b0 - vlib_buffer_t - Packet0
- * @param *b1 - vlib_buffer_t - Packet1
- * @param *t0 - vxlan_gpe_tunnel_t - contains rewrite header for Packet0
- * @param *t1 - vxlan_gpe_tunnel_t - contains rewrite header for Packet1
- * @param *next0 - u32 - relative index of next dispatch function (next node) for Packet0
- * @param *next1 - u32 - relative index of next dispatch function (next node) for Packet1
- * @param is_v4 - u8 - Is this IPv4? (or IPv6)
+ * @param *ngm
+ * @param *b0 Packet0
+ * @param *b1 Packet1
+ * @param *t0 contains rewrite header for Packet0
+ * @param *t1 contains rewrite header for Packet1
+ * @param *next0 relative index of next dispatch function (next node) for Packet0
+ * @param *next1 relative index of next dispatch function (next node) for Packet1
+ * @param is_v4 Is this IPv4? (or IPv6)
  *
  */
 always_inline void
@@ -160,11 +160,11 @@ vxlan_gpe_encap_two_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0, vlib_buf
  *      vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
  *
  * @node vxlan-gpe-input
- * @param *vm - vlib_main_t
- * @param *node - vlib_node_runtime_t
- * @param *from_frame - vlib_frame_t
+ * @param *vm
+ * @param *node
+ * @param *from_frame
  *
- * @return from_frame->n_vectors - uword
+ * @return from_frame->n_vectors
  *
  */
 static uword

diff --git a/vnet/vnet/vxlan-gpe/vxlan_gpe.c b/vnet/vnet/vxlan-gpe/vxlan_gpe.c
index 55e317c..c8c96fd 100644 (file)
--- a/vnet/vnet/vxlan-gpe/vxlan_gpe.c
+++ b/vnet/vnet/vxlan-gpe/vxlan_gpe.c
@@ -25,10 +25,10 @@ vxlan_gpe_main_t vxlan_gpe_main;
 /**
  * @brief Tracing function for VXLAN GPE tunnel packets
  *
- * @param *s - u8 - formatting string
- * @param *args - va_list
+ * @param *s
+ * @param *args
  *
- * @return *s - u8 - formmatted string
+ * @return *s
  *
  */
 u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
@@ -71,10 +71,10 @@ u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
 /**
  * @brief Naming for VXLAN GPE tunnel
  *
- * @param *s - u8 - formatting string
- * @param *args - va_list
+ * @param *s
+ * @param *args
  *
- * @return *s - u8 - formatted string
+ * @return *s
  *
  */
 static u8 * format_vxlan_gpe_name (u8 * s, va_list * args)
@@ -94,11 +94,11 @@ static uword dummy_interface_tx (vlib_main_t * vm,
 /**
  * @brief CLI function for VXLAN GPE admin up/down
  *
- * @param *vnm - vnet_main_t
- * @param hw_if_index - u32
- * @param flags - u32
+ * @param *vnm
+ * @param hw_if_index
+ * @param flags
  *
- * @return *rc - clib_error_t
+ * @return *rc
  *
  */
 static clib_error_t *
@@ -134,10 +134,10 @@ static uword dummy_set_rewrite (vnet_main_t * vnm,
 /**
  * @brief Formatting function for tracing VXLAN GPE with length
  *
- * @param *s - u8 - formatting string
- * @param *args - va_list
+ * @param *s
+ * @param *args
  *
- * @return *s - formatted string
+ * @return *s
  *
  */
 static u8 * format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
@@ -176,9 +176,9 @@ _(decap_fib_index)
 /**
  * @brief Calculate IPv4 VXLAN GPE rewrite header
  *
- * @param *t - vxlan_gpe_tunnel_t
+ * @param *t
  *
- * @return rc - int
+ * @return rc
  *
  */
 static int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t)
@@ -222,9 +222,9 @@ static int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t)
 /**
  * @brief Calculate IPv6 VXLAN GPE rewrite header
  *
- * @param *t - vxlan_gpe_tunnel_t
+ * @param *t
  *
- * @return rc - int
+ * @return rc
  *
  */
 static int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t)
@@ -268,10 +268,10 @@ static int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t)
 /**
  * @brief Add or Del a VXLAN GPE tunnel
  *
- * @param *a - vnet_vxlan_gpe_add_del_tunnel_args_t
- * @param *sw_if_index - u32
+ * @param *a
+ * @param *sw_if_index
  *
- * @return rc - int
+ * @return rc
  *
  */
 int vnet_vxlan_gpe_add_del_tunnel
@@ -422,9 +422,9 @@ int vnet_vxlan_gpe_add_del_tunnel
 /**
  * @brief Find the IPv4 FIB index from the FIB ID
  *
- * @param fib_id - u32
+ * @param fib_id
  *
- * @return fib_index - u32
+ * @return fib_index
  *
  */
 static u32 fib4_index_from_fib_id (u32 fib_id)
@@ -442,9 +442,9 @@ static u32 fib4_index_from_fib_id (u32 fib_id)
 /**
  * @brief Find the IPv4 FIB index from the FIB ID
  *
- * @param fib_id - u32
+ * @param fib_id
  *
- * @return fib_index - u32
+ * @return fib_index
  *
  */
 static u32 fib6_index_from_fib_id (u32 fib_id)
@@ -462,11 +462,11 @@ static u32 fib6_index_from_fib_id (u32 fib_id)
 /**
  * @brief CLI function for Add/Del of IPv4/IPv6 VXLAN GPE tunnel
  *
- * @param *vm - vlib_main_t
- * @param *input - unformat_input_t
- * @param *cmd - vlib_cli_command_t
+ * @param *vm
+ * @param *input
+ * @param *cmd
  *
- * @return error - clib_error_t
+ * @return error
  *
  */
 static clib_error_t *
@@ -624,11 +624,11 @@ VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
 /**
  * @brief CLI function for showing VXLAN GPE tunnels
  *
- * @param *vm - vlib_main_t
- * @param *input - unformat_input_t
- * @param *cmd - vlib_cli_command_t
+ * @param *vm
+ * @param *input
+ * @param *cmd
  *
- * @return error - clib_error_t
+ * @return error
  *
  */
 static clib_error_t *
@@ -658,9 +658,9 @@ VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
 /**
  * @brief Feature init function for VXLAN GPE
  *
- * @param *vm - vlib_main_t
+ * @param *vm
  *
- * @return error - clib_error_t
+ * @return error
  *
  */
 clib_error_t *vxlan_gpe_init (vlib_main_t *vm)