aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2019-11-01 13:00:58 -0400
committerDave Wallace <dwallacelf@gmail.com>2020-05-06 15:13:09 +0000
commitb5a575b0924036378b6deb50ac8fe7de3380e18d (patch)
treefae50e4af5256fe24838f7e85d1d6c17bcdc80d4 /src/vnet
parentaad5e0c16fb4d91f6d896f8035d6acb9bcd0fec6 (diff)
docs: clean up make docs job
Type: docs Change-Id: I9b5e5137eb4c1e89f6e8d7a278cd11a0fd496471 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
Diffstat (limited to 'src/vnet')
-rw-r--r--src/vnet/dpo/dpo.h4
-rw-r--r--src/vnet/fib/fib_walk.c2
-rw-r--r--src/vnet/ip/ip6.h2
-rw-r--r--src/vnet/lisp-gpe/lisp_gpe_tenant.c2
-rw-r--r--src/vnet/lldp/dir.dox2
-rw-r--r--src/vnet/mpls/mpls_tunnel.h2
-rw-r--r--src/vnet/syslog/syslog.c3
-rw-r--r--src/vnet/syslog/syslog.h3
-rw-r--r--src/vnet/syslog/syslog_udp.c3
-rw-r--r--src/vnet/syslog/syslog_udp.h3
10 files changed, 15 insertions, 11 deletions
diff --git a/src/vnet/dpo/dpo.h b/src/vnet/dpo/dpo.h
index 19b47f268b0..d3c2371c6dd 100644
--- a/src/vnet/dpo/dpo.h
+++ b/src/vnet/dpo/dpo.h
@@ -284,12 +284,12 @@ extern void dpo_copy(dpo_id_t *dst,
extern int dpo_is_adj(const dpo_id_t *dpo);
/**
- * @biref Format a DPO_id_t oject
+ * @brief Format a DPO_id_t oject
*/
extern u8 *format_dpo_id(u8 * s, va_list * args);
/**
- * @biref format a DPO type
+ * @brief format a DPO type
*/
extern u8 *format_dpo_type(u8 * s, va_list * args);
diff --git a/src/vnet/fib/fib_walk.c b/src/vnet/fib/fib_walk.c
index a09e34df3ba..7c832df0ae4 100644
--- a/src/vnet/fib/fib_walk.c
+++ b/src/vnet/fib/fib_walk.c
@@ -400,7 +400,7 @@ fib_walk_advance (fib_node_index_t fwi)
}
/**
- * @breif Enurmerate the times of sleep between walks
+ * @brief Enurmerate the times of sleep between walks
*/
typedef enum fib_walk_sleep_type_t_
{
diff --git a/src/vnet/ip/ip6.h b/src/vnet/ip/ip6.h
index 5e16f990534..ad70b7e98ec 100644
--- a/src/vnet/ip/ip6.h
+++ b/src/vnet/ip/ip6.h
@@ -338,7 +338,7 @@ clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
/**
- * @brie get first IPv6 interface address
+ * @brief get first IPv6 interface address
*/
ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
diff --git a/src/vnet/lisp-gpe/lisp_gpe_tenant.c b/src/vnet/lisp-gpe/lisp_gpe_tenant.c
index 8da1fd40b9d..e2a310c043c 100644
--- a/src/vnet/lisp-gpe/lisp_gpe_tenant.c
+++ b/src/vnet/lisp-gpe/lisp_gpe_tenant.c
@@ -272,7 +272,7 @@ lisp_gpe_tenant_flush (void)
}
/**
- * @brif Show/display one tenant
+ * @brief Show/display one tenant
*/
static u8 *
format_lisp_gpe_tenant (u8 * s, va_list * ap)
diff --git a/src/vnet/lldp/dir.dox b/src/vnet/lldp/dir.dox
index 6aa45f70f16..84870f81901 100644
--- a/src/vnet/lldp/dir.dox
+++ b/src/vnet/lldp/dir.dox
@@ -13,6 +13,6 @@
* limitations under the License.
*/
/**
- @dir vnet/vnet/lldp
+ @dir src/vnet/lldp
@brief Link Layer Discovery Protocol (LLDP) implementation
*/
diff --git a/src/vnet/mpls/mpls_tunnel.h b/src/vnet/mpls/mpls_tunnel.h
index 11a461b7b57..c060191f460 100644
--- a/src/vnet/mpls/mpls_tunnel.h
+++ b/src/vnet/mpls/mpls_tunnel.h
@@ -123,7 +123,7 @@ extern int vnet_mpls_tunnel_path_remove (u32 sw_if_index,
fib_route_path_t *rpath);
/**
- * @vrief return the tunnel index from the sw_if_index
+ * @brief return the tunnel index from the sw_if_index
*/
extern int vnet_mpls_tunnel_get_index (u32 sw_if_index);
diff --git a/src/vnet/syslog/syslog.c b/src/vnet/syslog/syslog.c
index f104691a614..f05ce8dc5ff 100644
--- a/src/vnet/syslog/syslog.c
+++ b/src/vnet/syslog/syslog.c
@@ -13,7 +13,8 @@
* limitations under the License.
*/
/**
- * @file RFC5424 syslog protocol implementation
+ * @file syslog.c
+ * RFC5424 syslog protocol implementation
*/
#include <unistd.h>
diff --git a/src/vnet/syslog/syslog.h b/src/vnet/syslog/syslog.h
index ed915877518..4809af48e97 100644
--- a/src/vnet/syslog/syslog.h
+++ b/src/vnet/syslog/syslog.h
@@ -13,7 +13,8 @@
* limitations under the License.
*/
/**
- * @file RFC5424 syslog protocol declarations
+ * @file syslog.h
+ * RFC5424 syslog protocol declarations
*/
#ifndef __included_syslog_h__
#define __included_syslog_h__
diff --git a/src/vnet/syslog/syslog_udp.c b/src/vnet/syslog/syslog_udp.c
index f4fa1d0baf5..a3b3bc487e2 100644
--- a/src/vnet/syslog/syslog_udp.c
+++ b/src/vnet/syslog/syslog_udp.c
@@ -13,7 +13,8 @@
* limitations under the License.
*/
/**
- * @file syslog protocol UDP transport layer implementation (RFC5426)
+ * @file syslog_udp.c
+ * syslog protocol UDP transport layer implementation (RFC5426)
*/
#include <vnet/syslog/syslog_udp.h>
diff --git a/src/vnet/syslog/syslog_udp.h b/src/vnet/syslog/syslog_udp.h
index 008fed70d19..8bbedcde3f2 100644
--- a/src/vnet/syslog/syslog_udp.h
+++ b/src/vnet/syslog/syslog_udp.h
@@ -13,7 +13,8 @@
* limitations under the License.
*/
/**
- * @file syslog protocol UDP transport layer declaration (RFC5426)
+ * @file syslog_udp.h
+ * syslog protocol UDP transport layer declaration (RFC5426)
*/
#ifndef __included_syslog_udp_h__
#define __included_syslog_udp_h__