[MONARCH_LTS,1/5] api: classification: add additional doxygen documentation

Message ID 20170712014545.13325-1-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/classification.h | 4 ++++
 1 file changed, 4 insertions(+)

-- 
2.11.0

Patch

diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h
index 523a8c41..7a6d9a5c 100644
--- a/include/odp/api/spec/classification.h
+++ b/include/odp/api/spec/classification.h
@@ -364,7 +364,9 @@  typedef struct odp_pmr_param_t {
 	/** True if the value is range and false if match */
 	odp_bool_t range_term;
 
+	/** Variant mappings for types of matches */
 	union {
+		/** Parameters for single-valued matches */
 		struct {
 			/** Value to be matched */
 			const void	*value;
@@ -372,6 +374,8 @@  typedef struct odp_pmr_param_t {
 			/** Masked set of bits to be matched */
 			const void	*mask;
 		} match;
+
+		/** Parameter for range value matches */
 		struct {
 			/** Start and End values are included in the range */
 			/** start value of range */