Port f38055d "linux-gen: packet: hide internal definitions from Doxygen"

Signed-off-by: Matias Elo <matias.elo@nokia.com>
Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

1 files changed, 50 insertions, 64 deletions

diff --git a/platform/linux-dpdk/include/odp/api/plat/packet_inline_types.h b/platform/linux-dpdk/include/odp/api/plat/packet_inline_types.h
index de6614a23..691560d3f 100644
--- a/platform/linux-dpdk/include/odp/api/plat/packet_inline_types.h
+++ b/platform/linux-dpdk/include/odp/api/plat/packet_inline_types.h
@@ -19,102 +19,88 @@ extern "C" {
 
 #include <stdint.h>
 
-/** @internal Packet field accessor */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+
+/* Packet field accessor */
 #define _odp_pkt_get(pkt, cast, field) \
 	(*(cast *)(uintptr_t)((uint8_t *)pkt + _odp_packet_inline.field))
 
-/** @internal Packet header field offsets for inline functions */
+/* Packet header field offsets for inline functions */
 typedef struct _odp_packet_inline_offset_t {
-	/** @internal field offset */
 	uint16_t mb;
-	/** @internal field offset */
 	uint16_t pool;
-	/** @internal field offset */
 	uint16_t input;
-	/** @internal field offset */
 	uint16_t user_ptr;
-	/** @internal field offset */
 	uint16_t l2_offset;
-	/** @internal field offset */
 	uint16_t l3_offset;
-	/** @internal field offset */
 	uint16_t l4_offset;
-	/** @internal field offset */
 	uint16_t timestamp;
-	/** @internal field offset */
 	uint16_t input_flags;
-	/** @internal field offset */
 	uint16_t buf_addr;
-	/** @internal field offset */
 	uint16_t data;
-	/** @internal field offset */
 	uint16_t pkt_len;
-	/** @internal field offset */
 	uint16_t seg_len;
-	/** @internal field offset */
 	uint16_t nb_segs;
-	/** @internal offset */
 	uint16_t udata;
-	/** @internal field offset */
 	uint16_t rss;
-	/** @internal field offset */
 	uint16_t ol_flags;
-	/** @internal rss hash result set */
 	uint64_t rss_flag;
 
 } _odp_packet_inline_offset_t;
 
-/** @internal Packet input & protocol flags */
+/* Packet input & protocol flags */
 typedef union {
-	/** All input flags */
+	/* All input flags */
 	uint64_t all;
 
-	/** Individual input flags */
+	/* Individual input flags */
 	struct {
-		uint64_t dst_queue:1; /**< Dst queue present */
-
-		uint64_t timestamp:1; /**< Timestamp present */
-
-		uint64_t l2:1;        /**< known L2 protocol present */
-		uint64_t l3:1;        /**< known L3 protocol present */
-		uint64_t l4:1;        /**< known L4 protocol present */
-
-		uint64_t eth:1;       /**< Ethernet */
-		uint64_t eth_bcast:1; /**< Ethernet broadcast */
-		uint64_t eth_mcast:1; /**< Ethernet multicast */
-		uint64_t jumbo:1;     /**< Jumbo frame */
-		uint64_t vlan:1;      /**< VLAN hdr found */
-		uint64_t vlan_qinq:1; /**< Stacked VLAN found, QinQ */
-
-		uint64_t snap:1;      /**< SNAP */
-		uint64_t arp:1;       /**< ARP */
-
-		uint64_t ipv4:1;      /**< IPv4 */
-		uint64_t ipv6:1;      /**< IPv6 */
-		uint64_t ip_bcast:1;  /**< IP broadcast */
-		uint64_t ip_mcast:1;  /**< IP multicast */
-		uint64_t ipfrag:1;    /**< IP fragment */
-		uint64_t ipopt:1;     /**< IP optional headers */
-
-		uint64_t ipsec:1;     /**< IPSec packet. Required by the
-					   odp_packet_has_ipsec_set() func. */
-		uint64_t ipsec_ah:1;  /**< IPSec authentication header */
-		uint64_t ipsec_esp:1; /**< IPSec encapsulating security
-					   payload */
-		uint64_t udp:1;       /**< UDP */
-		uint64_t tcp:1;       /**< TCP */
-		uint64_t sctp:1;      /**< SCTP */
-		uint64_t icmp:1;      /**< ICMP */
-
-		uint64_t color:2;     /**< Packet color for traffic mgmt */
-		uint64_t nodrop:1;    /**< Drop eligibility status */
-
-		uint64_t l3_chksum_done:1; /**< L3 checksum validation done */
-		uint64_t l4_chksum_done:1; /**< L4 checksum validation done */
-		uint64_t ipsec_udp:1; /**< UDP-encapsulated IPsec packet */
+		uint64_t dst_queue:1; /* Dst queue present */
+
+		uint64_t timestamp:1; /* Timestamp present */
+
+		uint64_t l2:1;        /* known L2 protocol present */
+		uint64_t l3:1;        /* known L3 protocol present */
+		uint64_t l4:1;        /* known L4 protocol present */
+
+		uint64_t eth:1;       /* Ethernet */
+		uint64_t eth_bcast:1; /* Ethernet broadcast */
+		uint64_t eth_mcast:1; /* Ethernet multicast */
+		uint64_t jumbo:1;     /* Jumbo frame */
+		uint64_t vlan:1;      /* VLAN hdr found */
+		uint64_t vlan_qinq:1; /* Stacked VLAN found, QinQ */
+
+		uint64_t snap:1;      /* SNAP */
+		uint64_t arp:1;       /* ARP */
+
+		uint64_t ipv4:1;      /* IPv4 */
+		uint64_t ipv6:1;      /* IPv6 */
+		uint64_t ip_bcast:1;  /* IP broadcast */
+		uint64_t ip_mcast:1;  /* IP multicast */
+		uint64_t ipfrag:1;    /* IP fragment */
+		uint64_t ipopt:1;     /* IP optional headers */
+
+		uint64_t ipsec:1;     /* IPSec packet. Required by the
+					 odp_packet_has_ipsec_set() func. */
+		uint64_t ipsec_ah:1;  /* IPSec authentication header */
+		uint64_t ipsec_esp:1; /* IPSec encapsulating security
+					 payload */
+		uint64_t udp:1;       /* UDP */
+		uint64_t tcp:1;       /* TCP */
+		uint64_t sctp:1;      /* SCTP */
+		uint64_t icmp:1;      /* ICMP */
+
+		uint64_t color:2;     /* Packet color for traffic mgmt */
+		uint64_t nodrop:1;    /* Drop eligibility status */
+
+		uint64_t l3_chksum_done:1; /* L3 checksum validation done */
+		uint64_t l4_chksum_done:1; /* L4 checksum validation done */
+		uint64_t ipsec_udp:1; /* UDP-encapsulated IPsec packet */
 	};
 } _odp_packet_input_flags_t;
 
+/** @endcond */
+
 #ifdef __cplusplus
 }
 #endif