aboutsummaryrefslogtreecommitdiffstats
path: root/vnet/vnet/l2/l2_learn.c
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-09-01 14:31:46 -0400
committerChris Luke <chrisy@flirble.org>2016-09-01 14:31:46 -0400
commit16bcf7d8dcd411e6a6b8d217cce5e450f7357bb3 (patch)
tree4c59b98b9b357150af939c035ec4e8776bac2b2e /vnet/vnet/l2/l2_learn.c
parentf074eef0409a64475e840f59581306273313b218 (diff)
VPP-346 A swathe of doc fixes
Fixes various Doxygen warnings and other structural defects. Note: This does not attempt to improve the content of the documentation; only to improve the syntax and structure of it and in some cases the consistency. Change-Id: Ib1915f33edbdbc4558c85565de80dce323193906 Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'vnet/vnet/l2/l2_learn.c')
-rw-r--r--vnet/vnet/l2/l2_learn.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/vnet/vnet/l2/l2_learn.c b/vnet/vnet/l2/l2_learn.c
index 30f5617f05e..96d4816e1e6 100644
--- a/vnet/vnet/l2/l2_learn.c
+++ b/vnet/vnet/l2/l2_learn.c
@@ -29,8 +29,9 @@
#include <vppinfra/error.h>
#include <vppinfra/hash.h>
-/*
- * Ethernet bridge learning
+/**
+ * @file
+ * Ethernet bridge learning.
*
* Populate the mac table with entries mapping the packet's source mac + bridge
* domain ID to the input sw_if_index.
@@ -102,7 +103,7 @@ typedef enum
} l2learn_next_t;
-/** Perform learning on one packet based on the mac table lookup result */
+/** Perform learning on one packet based on the mac table lookup result. */
static_always_inline void
l2learn_process (vlib_node_runtime_t * node,
@@ -462,7 +463,7 @@ VLIB_INIT_FUNCTION (l2learn_init);
/**
- * set subinterface learn enable/disable
+ * Set subinterface learn enable/disable.
* The CLI format is:
* set interface l2 learn <interface> [disable]
*/