Improve MFIB doxygen help 79/5079/2
authorNeale Ranns <nranns@cisco.com>
Wed, 8 Feb 2017 17:11:57 +0000 (09:11 -0800)
committerNeale Ranns <nranns@cisco.com>
Thu, 9 Feb 2017 09:51:11 +0000 (09:51 +0000)
Change-Id: Ie490b7fd5238cbad23f0199161cc14324fd9c554
Signed-off-by: Neale Ranns <nranns@cisco.com>
src/vnet/mfib/ip4_mfib.c
src/vnet/mfib/mfib_entry.c
src/vnet/mfib/mfib_itf.c
src/vnet/mfib/mfib_types.c

index 08001c3..3e7bdd8 100644 (file)
@@ -457,9 +457,9 @@ ip4_show_mfib (vlib_main_t * vm,
  * @cliexend
  ?*/
 /* *INDENT-OFF* */
-VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
+VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
     .path = "show ip mfib",
-    .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<gre-addr>[/<mask>]] [<gre-addr>] [<src-addr> <gre-addr>]",
+    .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
     .function = ip4_show_mfib,
 };
 /* *INDENT-ON* */
index 5170080..f1b6e8e 100644 (file)
@@ -1147,6 +1147,10 @@ show_mfib_entry_command (vlib_main_t * vm,
     return (NULL);
 }
 
+/*?
+ * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
+ * numerical indentifier.
+ ?*/
 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
   .path = "show mfib entry",
   .function = show_mfib_entry_command,
index b9fa1ec..f77b40e 100644 (file)
@@ -112,6 +112,10 @@ show_mfib_itf_command (vlib_main_t * vm,
     return (NULL);
 }
 
+/*?
+ * This commnad displays an MFIB interface, or all interfaces, indexed by their unique
+ * numerical indentifier.
+ ?*/
 VLIB_CLI_COMMAND (show_mfib_itf, static) = {
   .path = "show mfib interface",
   .function = show_mfib_itf_command,
index 68b1ac5..8452d86 100644 (file)
@@ -171,7 +171,7 @@ mfib_show_route_flags (vlib_main_t * vm,
 }
 
 /*?
- * This command display the set of support flags applicable to the MFIB route
+ * This command displays the set of supported flags applicable to an MFIB route
  */
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (mfib_route_flags_command, static) =
@@ -200,7 +200,7 @@ mfib_show_itf_flags (vlib_main_t * vm,
 }
 
 /*?
- * This command display the set of support flags applicable to the MFIB route
+ * This command displays the set of supported flags applicable to an MFIB interface
  */
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (mfib_itf_flags_command, static) =