helper: remove ODP_STATIC_ASSERT macros from doxygen output

ODP_STATIC_ASSERT macros were previously recognized as functions by Doxygen. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
OpenDataPlane · Aug 30, 2023 · 65e4d3f · 65e4d3f
1 parent 9241369
commit 65e4d3f
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 23 deletions.
diff --git a/helper/include/odp/helper/eth.h b/helper/include/odp/helper/eth.h
@@ -57,10 +57,6 @@ typedef struct ODP_PACKED {
 	uint8_t addr[ODPH_ETHADDR_LEN]; /**< Address */
 } odph_ethaddr_t;
 
-/** @internal Compile time assert */
-ODP_STATIC_ASSERT(sizeof(odph_ethaddr_t) == ODPH_ETHADDR_LEN,
-		  "ODPH_ETHADDR_T__SIZE_ERROR");
-
 /**
  * Ethernet header
  */
@@ -70,10 +66,6 @@ typedef struct ODP_PACKED {
 	odp_u16be_t type;   /**< EtherType */
 } odph_ethhdr_t;
 
-/** @internal Compile time assert */
-ODP_STATIC_ASSERT(sizeof(odph_ethhdr_t) == ODPH_ETHHDR_LEN,
-		  "ODPH_ETHHDR_T__SIZE_ERROR");
-
 /**
  * IEEE 802.1Q VLAN header
  *
@@ -88,9 +80,16 @@ typedef struct ODP_PACKED {
 	odp_u16be_t type;  /**< Inner EtherType */
 } odph_vlanhdr_t;
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+ODP_STATIC_ASSERT(sizeof(odph_ethaddr_t) == ODPH_ETHADDR_LEN,
+		  "ODPH_ETHADDR_T__SIZE_ERROR");
+
+ODP_STATIC_ASSERT(sizeof(odph_ethhdr_t) == ODPH_ETHHDR_LEN,
+		  "ODPH_ETHHDR_T__SIZE_ERROR");
+
 ODP_STATIC_ASSERT(sizeof(odph_vlanhdr_t) == ODPH_VLANHDR_LEN,
 		  "ODPH_VLANHDR_T__SIZE_ERROR");
+/** @endcond */
 
 /* Ethernet header Ether Type ('type') values, a selected few */
 #define ODPH_ETHTYPE_IPV4       0x0800 /**< Internet Protocol version 4 */

diff --git a/helper/include/odp/helper/icmp.h b/helper/include/odp/helper/icmp.h
@@ -95,9 +95,10 @@ typedef struct ODP_PACKED {
 #define ICMP_EXC_FRAGTIME	1	/**< Fragment Reass time
 								exceeded*/
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
 ODP_STATIC_ASSERT(sizeof(odph_icmphdr_t) == ODPH_ICMPHDR_LEN,
 		  "ODPH_ICMPHDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * @}

diff --git a/helper/include/odp/helper/ip.h b/helper/include/odp/helper/ip.h
@@ -92,9 +92,10 @@ typedef struct ODP_PACKED {
 	odp_u32be_t dst_addr;   /**< Destination address */
 } odph_ipv4hdr_t;
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
 ODP_STATIC_ASSERT(sizeof(odph_ipv4hdr_t) == ODPH_IPV4HDR_LEN,
 		  "ODPH_IPV4HDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * Calculate IPv4 header checksum
@@ -233,9 +234,10 @@ typedef struct ODP_PACKED {
 	uint8_t    dst_addr[16]; /**< Destination address */
 } odph_ipv6hdr_t;
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
 ODP_STATIC_ASSERT(sizeof(odph_ipv6hdr_t) == ODPH_IPV6HDR_LEN,
 		  "ODPH_IPV6HDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * IPv6 Header extensions

diff --git a/helper/include/odp/helper/ipsec.h b/helper/include/odp/helper/ipsec.h
@@ -39,10 +39,6 @@ typedef struct ODP_PACKED {
 	uint8_t    iv[];     /**< Initialization vector */
 } odph_esphdr_t;
 
-/** @internal Compile time assert */
-ODP_STATIC_ASSERT(sizeof(odph_esphdr_t) == ODPH_ESPHDR_LEN,
-		  "ODPH_ESPHDR_T__SIZE_ERROR");
-
 /**
  * IPSec ESP trailer
  */
@@ -52,10 +48,6 @@ typedef struct ODP_PACKED {
 	uint8_t icv[];        /**< Integrity Check Value (optional) */
 } odph_esptrl_t;
 
-/** @internal Compile time assert */
-ODP_STATIC_ASSERT(sizeof(odph_esptrl_t) == ODPH_ESPTRL_LEN,
-		  "ODPH_ESPTRL_T__SIZE_ERROR");
-
 /**
  * IPSec AH header
  */
@@ -68,9 +60,16 @@ typedef struct ODP_PACKED {
 	uint8_t    icv[];        /**< Integrity Check Value */
 } odph_ahhdr_t;
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
+ODP_STATIC_ASSERT(sizeof(odph_esphdr_t) == ODPH_ESPHDR_LEN,
+		  "ODPH_ESPHDR_T__SIZE_ERROR");
+
+ODP_STATIC_ASSERT(sizeof(odph_esptrl_t) == ODPH_ESPTRL_LEN,
+		  "ODPH_ESPTRL_T__SIZE_ERROR");
+
 ODP_STATIC_ASSERT(sizeof(odph_ahhdr_t) == ODPH_AHHDR_LEN,
 		  "ODPH_AHHDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * Check IPSEC algorithm support

diff --git a/helper/include/odp/helper/sctp.h b/helper/include/odp/helper/sctp.h
@@ -35,9 +35,10 @@ typedef struct ODP_PACKED {
 	odp_u32be_t chksum;   /**< SCTP header and data checksum */
 } odph_sctphdr_t;
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
 ODP_STATIC_ASSERT(sizeof(odph_sctphdr_t) == ODPH_SCTPHDR_LEN,
 		  "ODPH_SCTPHDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * @}

diff --git a/helper/include/odp/helper/udp.h b/helper/include/odp/helper/udp.h
@@ -53,9 +53,10 @@ static inline uint16_t odph_ipv4_udp_chksum(odp_packet_t pkt)
 	return (rc == 0) ? chksum : 0;
 }
 
-/** @internal Compile time assert */
+/** @cond _ODP_HIDE_FROM_DOXYGEN_ */
 ODP_STATIC_ASSERT(sizeof(odph_udphdr_t) == ODPH_UDPHDR_LEN,
 		  "ODPH_UDPHDR_T__SIZE_ERROR");
+/** @endcond */
 
 /**
  * @}