diff options
author | Chris Luke <chrisy@flirble.org> | 2016-09-01 14:31:46 -0400 |
---|---|---|
committer | Chris Luke <chrisy@flirble.org> | 2016-09-01 14:31:46 -0400 |
commit | 16bcf7d8dcd411e6a6b8d217cce5e450f7357bb3 (patch) | |
tree | 4c59b98b9b357150af939c035ec4e8776bac2b2e /vnet/vnet/ipsec-gre | |
parent | f074eef0409a64475e840f59581306273313b218 (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/ipsec-gre')
-rw-r--r-- | vnet/vnet/ipsec-gre/error.def | 2 | ||||
-rw-r--r-- | vnet/vnet/ipsec-gre/interface.c | 2 | ||||
-rw-r--r-- | vnet/vnet/ipsec-gre/ipsec_gre.c | 2 | ||||
-rw-r--r-- | vnet/vnet/ipsec-gre/ipsec_gre.h | 2 | ||||
-rw-r--r-- | vnet/vnet/ipsec-gre/node.c | 6 |
5 files changed, 7 insertions, 7 deletions
diff --git a/vnet/vnet/ipsec-gre/error.def b/vnet/vnet/ipsec-gre/error.def index 0d7b4686f8a..d84e8ed1759 100644 --- a/vnet/vnet/ipsec-gre/error.def +++ b/vnet/vnet/ipsec-gre/error.def @@ -13,7 +13,7 @@ * limitations under the License. */ /** - * @file error.def + * @file * @brief L2-GRE over IPSec errors. */ diff --git a/vnet/vnet/ipsec-gre/interface.c b/vnet/vnet/ipsec-gre/interface.c index 3e5d3954341..dbf9df5628a 100644 --- a/vnet/vnet/ipsec-gre/interface.c +++ b/vnet/vnet/ipsec-gre/interface.c @@ -15,7 +15,7 @@ * limitations under the License. */ /** - * @file interface.c + * @file * @brief L2-GRE over IPSec tunnel interface. * * Creates ipsec-gre tunnel interface. diff --git a/vnet/vnet/ipsec-gre/ipsec_gre.c b/vnet/vnet/ipsec-gre/ipsec_gre.c index 24ec6f4e9d6..3d1b54fc7f9 100644 --- a/vnet/vnet/ipsec-gre/ipsec_gre.c +++ b/vnet/vnet/ipsec-gre/ipsec_gre.c @@ -13,7 +13,7 @@ * limitations under the License. */ /** - * @file ipsec_gre.c + * @file * @brief L2-GRE over IPSec packet processing. * * Add GRE header to thr packet and send it to the esp-encrypt node. diff --git a/vnet/vnet/ipsec-gre/ipsec_gre.h b/vnet/vnet/ipsec-gre/ipsec_gre.h index 2b66c6a6e8a..a2ca64b6f74 100644 --- a/vnet/vnet/ipsec-gre/ipsec_gre.h +++ b/vnet/vnet/ipsec-gre/ipsec_gre.h @@ -13,7 +13,7 @@ * limitations under the License. */ /** - * @file ipsec_gre.h + * @file * @brief L2-GRE over IPSec packet processing. */ diff --git a/vnet/vnet/ipsec-gre/node.c b/vnet/vnet/ipsec-gre/node.c index 131025521f3..5a176088862 100644 --- a/vnet/vnet/ipsec-gre/node.c +++ b/vnet/vnet/ipsec-gre/node.c @@ -13,10 +13,10 @@ * limitations under the License. */ /** - * @file node.c + * @file * @brief L2-GRE over IPSec packet processing. * - * Removes GRE header from the packet and send it to the l2-input node. + * Removes GRE header from the packet and sends it to the l2-input node. */ #include <vlib/vlib.h> @@ -68,7 +68,7 @@ u8 * format_ipsec_gre_rx_trace (u8 * s, va_list * args) * * @par Graph mechanics: buffer metadata, next index usage * - * <em>Uses:<em> + * <em>Uses:</em> * - <code>ip->src_address</code> and <code>ip->dst_address</code> * - Match tunnel by source and destination addresses in GRE IP header. * |