[MONARCH_LTS,3/5] api: tm: add additional doxygen documentation

Message ID 20170712014545.13325-3-bill.fischofer@linaro.org
State New
Headers show
Series
  • [MONARCH_LTS,1/5] api: classification: add additional doxygen documentation
Related show

Commit Message

Bill Fischofer July 12, 2017, 1:45 a.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/traffic_mngr.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

-- 
2.11.0

Patch

diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h
index 34736484..ce27bcab 100644
--- a/include/odp/api/spec/traffic_mngr.h
+++ b/include/odp/api/spec/traffic_mngr.h
@@ -471,9 +471,10 @@  typedef enum {
 typedef struct {
 	odp_tm_egress_kind_t egress_kind; /**< Union discriminator */
 
+	/** Variant parameters for different TM outputs */
 	union {
-		odp_pktio_t pktio;
-		odp_tm_egress_fcn_t egress_fcn;
+		odp_pktio_t pktio;              /**< Output to PktIO */
+		odp_tm_egress_fcn_t egress_fcn; /**< Output to user func */
 	};
 } odp_tm_egress_t;