[API-NEXT,PATCHv3,2/6] api: ipsec: add additional doxygen documentation

Message ID 1492784725-31626-2-git-send-email-bill.fischofer@linaro.org
State New
Headers show
Series
  • [API-NEXT,PATCHv3,1/6] api: classification: add additional doxygen documentation
Related show

Commit Message

Bill Fischofer April 21, 2017, 2:25 p.m.
Resolve Bug https://bugs.linaro.org/show_bug.cgi?id=2952 by adding
additional field documentation to avoid problems with doxygen 1.8.13
and higher.

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

---
 include/odp/api/spec/ipsec.h | 5 +++++
 1 file changed, 5 insertions(+)

-- 
2.11.0

Patch hide | download patch | download mbox

diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h
index a0ceb11a..3521d2f8 100644
--- a/include/odp/api/spec/ipsec.h
+++ b/include/odp/api/spec/ipsec.h
@@ -157,6 +157,7 @@  typedef struct odp_ipsec_inbound_config_t {
 	/** Flags to control IPSEC payload data checks up to the selected parse
 	 *  level. */
 	union {
+		/** Mapping for individual bits */
 		struct {
 			/** Check IPv4 header checksum in IPSEC payload.
 			 *  Default value is 0. */
@@ -195,6 +196,7 @@  typedef struct odp_ipsec_outbound_config_t {
 	 *  metadata flag to disable checksum insertion per packet bases.
 	 */
 	union {
+		/** Mapping for individual bits */
 		struct {
 			/** Insert IPv4 header checksum on the payload packet
 			 *  before IPSEC transformation. Default value is 0. */
@@ -393,6 +395,7 @@  typedef struct odp_ipsec_tunnel_param_t {
 	/** Tunnel type: IPv4 or IPv6 */
 	odp_ipsec_tunnel_type_t type;
 
+	/** Variant mappings for tunnel parameters */
 	union {
 		/** IPv4 header parameters */
 		struct {
@@ -850,6 +853,7 @@  typedef struct odp_ipsec_op_opt_t {
 
 /** IPSEC operation status */
 typedef struct odp_ipsec_op_status_t {
+	/** Variant mappings for op status */
 	union {
 		/** Error flags */
 		struct {
@@ -901,6 +905,7 @@  typedef struct odp_ipsec_op_status_t {
 		uint32_t all_error;
 	};
 
+	/** Variant mappings for status flags */
 	union {
 		/** Status flags */
 		struct {