diff mbox

[3/3] helper: doxygen: group packet headers logically

Message ID 1429120348-8213-3-git-send-email-mike.holmes@linaro.org
State Accepted
Commit f42930a55162065b295958443278c01449ef17ad
Headers show

Commit Message

Mike Holmes April 15, 2015, 5:52 p.m. UTC 
The headers are all closely related but do not appear that way in the
documentation, gather them together

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 helper/include/odp/helper/eth.h   | 8 ++++++++
 helper/include/odp/helper/icmp.h  | 8 ++++++++
 helper/include/odp/helper/ip.h    | 7 +++++++
 helper/include/odp/helper/ipsec.h | 8 ++++++++
 helper/include/odp/helper/tcp.h   | 9 +++++++++
 helper/include/odp/helper/udp.h   | 9 +++++++++
 6 files changed, 49 insertions(+)
diff mbox

Patch

diff --git a/helper/include/odp/helper/eth.h b/helper/include/odp/helper/eth.h
index 4d0f715..f1c164d 100644
--- a/helper/include/odp/helper/eth.h
+++ b/helper/include/odp/helper/eth.h
@@ -23,6 +23,10 @@  extern "C" {
 #include <odp/align.h>
 #include <odp/debug.h>
 
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
 #define ODPH_ETHADDR_LEN     6    /**< Ethernet address length */
 #define ODPH_ETHHDR_LEN      14   /**< Ethernet header length */
 #define ODPH_VLANHDR_LEN     4    /**< VLAN header length */
@@ -80,6 +84,10 @@  _ODP_STATIC_ASSERT(sizeof(odph_vlanhdr_t) == ODPH_VLANHDR_LEN, "ODPH_VLANHDR_T__
 #define ODPH_ETHTYPE_MACSEC     0x88E5 /**< MAC security IEEE 802.1AE */
 #define ODPH_ETHTYPE_1588       0x88F7 /**< Precision Time Protocol IEEE 1588 */
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/helper/include/odp/helper/icmp.h b/helper/include/odp/helper/icmp.h
index 476af02..abcf818 100644
--- a/helper/include/odp/helper/icmp.h
+++ b/helper/include/odp/helper/icmp.h
@@ -22,6 +22,10 @@  extern "C" {
 #include <odp/debug.h>
 #include <odp/byteorder.h>
 
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
 /** ICMP header length */
 #define ODPH_ICMPHDR_LEN 8
 
@@ -92,6 +96,10 @@  typedef struct ODP_PACKED {
 /** @internal Compile time assert */
 _ODP_STATIC_ASSERT(sizeof(odph_icmphdr_t) == ODPH_ICMPHDR_LEN, "ODPH_ICMPHDR_T__SIZE_ERROR");
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/helper/include/odp/helper/ip.h b/helper/include/odp/helper/ip.h
index 95fabe3..627c82d 100644
--- a/helper/include/odp/helper/ip.h
+++ b/helper/include/odp/helper/ip.h
@@ -25,6 +25,10 @@  extern "C" {
 
 #include <string.h>
 
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
 #define ODPH_IPV4             4  /**< IP version 4 */
 #define ODPH_IPV4HDR_LEN     20  /**< Min length of IP header (no options) */
 #define ODPH_IPV4HDR_IHL_MIN  5  /**< Minimum IHL value*/
@@ -171,6 +175,9 @@  typedef struct ODP_PACKED {
 
 /**@}*/
 
+/**
+ * @}
+ */
 #ifdef __cplusplus
 }
 #endif
diff --git a/helper/include/odp/helper/ipsec.h b/helper/include/odp/helper/ipsec.h
index 70c6b9c..2565f74 100644
--- a/helper/include/odp/helper/ipsec.h
+++ b/helper/include/odp/helper/ipsec.h
@@ -23,6 +23,10 @@  extern "C" {
 #include <odp/align.h>
 #include <odp/debug.h>
 
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
 #define ODPH_ESPHDR_LEN      8    /**< IPSec ESP header length */
 #define ODPH_ESPTRL_LEN      2    /**< IPSec ESP trailer length */
 #define ODPH_AHHDR_LEN      12    /**< IPSec AH header length */
@@ -66,6 +70,10 @@  typedef struct ODP_PACKED {
 /** @internal Compile time assert */
 _ODP_STATIC_ASSERT(sizeof(odph_ahhdr_t) == ODPH_AHHDR_LEN, "ODPH_AHHDR_T__SIZE_ERROR");
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/helper/include/odp/helper/tcp.h b/helper/include/odp/helper/tcp.h
index 0d9ec18..defe422 100644
--- a/helper/include/odp/helper/tcp.h
+++ b/helper/include/odp/helper/tcp.h
@@ -22,6 +22,11 @@  extern "C" {
 #include <odp/debug.h>
 #include <odp/byteorder.h>
 
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
+
 /** TCP header */
 typedef struct ODP_PACKED {
 	uint16be_t src_port; /**< Source port */
@@ -74,6 +79,10 @@  typedef struct ODP_PACKED {
 	uint16be_t urgptr; /**< Urgent pointer */
 } odph_tcphdr_t;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/helper/include/odp/helper/udp.h b/helper/include/odp/helper/udp.h
index 99a96f2..866145a 100644
--- a/helper/include/odp/helper/udp.h
+++ b/helper/include/odp/helper/udp.h
@@ -22,6 +22,11 @@  extern "C" {
 #include <odp/debug.h>
 #include <odp/byteorder.h>
 
+
+/** @addtogroup odph_header ODPH HEADER
+ *  @{
+ */
+
 /** UDP header length */
 #define ODPH_UDPHDR_LEN 8
 
@@ -95,6 +100,10 @@  static inline uint16_t odph_ipv4_udp_chksum(odp_packet_t pkt)
 /** @internal Compile time assert */
 _ODP_STATIC_ASSERT(sizeof(odph_udphdr_t) == ODPH_UDPHDR_LEN, "ODPH_UDPHDR_T__SIZE_ERROR");
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif