From b5a575b0924036378b6deb50ac8fe7de3380e18d Mon Sep 17 00:00:00 2001
From: Paul Vinciguerra <pvinci@vinciconsulting.com>
Date: Fri, 1 Nov 2019 13:00:58 -0400
Subject: docs: clean up make docs job

Type: docs

Change-Id: I9b5e5137eb4c1e89f6e8d7a278cd11a0fd496471
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
---
 src/plugins/igmp/igmp.c        | 14 +++++++-------
 src/plugins/igmp/igmp_api.h    |  3 +--
 src/plugins/igmp/igmp_config.h |  1 -
 src/plugins/igmp/igmp_proxy.h  |  4 ++--
 src/plugins/igmp/igmp_timer.c  |  1 -
 5 files changed, 10 insertions(+), 13 deletions(-)

(limited to 'src/plugins/igmp')

diff --git a/src/plugins/igmp/igmp.c b/src/plugins/igmp/igmp.c
index eea39d33da2..1c686e39cf2 100644
--- a/src/plugins/igmp/igmp.c
+++ b/src/plugins/igmp/igmp.c
@@ -303,13 +303,6 @@ error:
   return (rv);
 }
 
-/** \brief igmp hardware interface link up down
-    @param vnm - vnet main
-    @param hw_if_index - interface hw_if_index
-    @param flags - hw interface flags
-
-    If an interface goes down, remove its (S,G)s.
-*/
 static walk_rc_t
 igmp_sw_if_down (vnet_main_t * vnm, u32 sw_if_index, void *ctx)
 {
@@ -325,6 +318,13 @@ igmp_sw_if_down (vnet_main_t * vnm, u32 sw_if_index, void *ctx)
   return (WALK_CONTINUE);
 }
 
+/** \brief igmp hardware interface link up down
+    @param vnm - vnet main
+    @param hw_if_index - interface hw_if_index
+    @param flags - hw interface flags
+
+    If an interface goes down, remove its (S,G)s.
+*/
 static clib_error_t *
 igmp_hw_interface_link_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 {
diff --git a/src/plugins/igmp/igmp_api.h b/src/plugins/igmp/igmp_api.h
index cfeab920c1d..81df4fd2aa6 100644
--- a/src/plugins/igmp/igmp_api.h
+++ b/src/plugins/igmp/igmp_api.h
@@ -33,11 +33,10 @@ int igmp_enable_disable (u32 sw_if_index, u8 enable, u8 mode);
 /**
  * @brief igmp listen (RFC3376 Section 2).
  * @param vm - vlib main
- * @param enable - 0 == remove (S,G), else add (S,G), aka. include/exclue
+ * @param enable - 0 == remove (S,G), else add (S,G), aka. include/exclude
  * @param sw_if_index - interface sw_if_index
  * @param saddr - source address
  * @param gaddr - group address
- * @param cli_api_configured - if zero, an igmp report has been received on interface
  *
  *   Add/del (S,G) on an interface. If user configured,
  *   send a status change report from the interface.
diff --git a/src/plugins/igmp/igmp_config.h b/src/plugins/igmp/igmp_config.h
index e3cd5d844c8..f03afe199cc 100644
--- a/src/plugins/igmp/igmp_config.h
+++ b/src/plugins/igmp/igmp_config.h
@@ -103,7 +103,6 @@ extern void igmp_clear_config (igmp_config_t * config);
 
 /**
  * @brief igmp config lookup
- *  @param im - igmp main
  *  @param sw_if_index - interface sw_if_index
  */
 extern igmp_config_t *igmp_config_lookup (u32 sw_if_index);
diff --git a/src/plugins/igmp/igmp_proxy.h b/src/plugins/igmp/igmp_proxy.h
index 6d49159518b..b71b751855c 100644
--- a/src/plugins/igmp/igmp_proxy.h
+++ b/src/plugins/igmp/igmp_proxy.h
@@ -26,7 +26,7 @@ typedef struct
   /* VRF index */
   u32 vrf_id;
 
-  /* upstrema interface */
+  /* upstream interface */
   u32 upstream_if;
 
   /* downstream interfaces */
@@ -41,7 +41,7 @@ typedef struct
  *
  * Add/del IGMP proxy device. Interface must be IGMP enabled in HOST mode.
  */
-int igmp_proxy_device_add_del (u32 vfr_id, u32 sw_if_index, u8 add);
+int igmp_proxy_device_add_del (u32 vrf_id, u32 sw_if_index, u8 add);
 
 /**
  * @brief IGMP proxy device add/del interface
diff --git a/src/plugins/igmp/igmp_timer.c b/src/plugins/igmp/igmp_timer.c
index afa0c3693c9..2d38dd07a99 100644
--- a/src/plugins/igmp/igmp_timer.c
+++ b/src/plugins/igmp/igmp_timer.c
@@ -95,7 +95,6 @@ igmp_timer_compare (const void *_v1, const void *_v2)
 }
 
 /** \brief igmp get next timer
-    @param im - igmp main
 
     Get next timer.
 */
-- 
cgit 1.2.3-korg