From: Thomas Monjalon <thomas@monjalon.net>
Date: Wed, 19 May 2021 17:33:16 +0000 (+0200)
Subject: ethdev: fix comments of packet integrity flow item
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=0d025f019c68e80d0e2f09764465dcd0afdd7cd9;p=dpdk.git

ethdev: fix comments of packet integrity flow item

The Doxygen comments are placed before the related lines,
but the markers were /**< instead of /**

The struct rte_flow_item_integrity did not appear in Doxygen output
because there was no general comment for the struct.

Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
---

diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 94c8c1ccc8..961a5884fe 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -1707,8 +1707,16 @@ rte_flow_item_geneve_opt_mask = {
 };
 #endif
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ *
+ * RTE_FLOW_ITEM_TYPE_INTEGRITY
+ *
+ * Match on packet integrity check result.
+ */
 struct rte_flow_item_integrity {
-	/**< Tunnel encapsulation level the item should apply to.
+	/** Tunnel encapsulation level the item should apply to.
 	 * @see rte_flow_action_rss
 	 */
 	uint32_t level;
@@ -1716,21 +1724,21 @@ struct rte_flow_item_integrity {
 	union {
 		__extension__
 		struct {
-			/**< The packet is valid after passing all HW checks. */
+			/** The packet is valid after passing all HW checks. */
 			uint64_t packet_ok:1;
-			/**< L2 layer is valid after passing all HW checks. */
+			/** L2 layer is valid after passing all HW checks. */
 			uint64_t l2_ok:1;
-			/**< L3 layer is valid after passing all HW checks. */
+			/** L3 layer is valid after passing all HW checks. */
 			uint64_t l3_ok:1;
-			/**< L4 layer is valid after passing all HW checks. */
+			/** L4 layer is valid after passing all HW checks. */
 			uint64_t l4_ok:1;
-			/**< L2 layer CRC is valid. */
+			/** L2 layer CRC is valid. */
 			uint64_t l2_crc_ok:1;
-			/**< IPv4 layer checksum is valid. */
+			/** IPv4 layer checksum is valid. */
 			uint64_t ipv4_csum_ok:1;
-			/**< L4 layer checksum is valid. */
+			/** L4 layer checksum is valid. */
 			uint64_t l4_csum_ok:1;
-			/**< The l3 length is smaller than the frame length. */
+			/** L3 length is smaller than frame length. */
 			uint64_t l3_len_ok:1;
 			uint64_t reserved:56;
 		};