[API-NEXT,PATCHv3,1/6] api: classification: add additional doxygen documentation

Message ID 1492784725-31626-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit b8de7dfbadb10da65a0a675db5f588cc3998508a
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/classification.h | 4 ++++
 1 file changed, 4 insertions(+)

-- 
2.11.0

Comments

Savolainen, Petri (Nokia - FI/Espoo) April 24, 2017, 11:29 a.m. | #1
Reviewed-by: Petri Savolainen <petri.savolainen@linaro.org>



> -----Original Message-----

> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of Bill

> Fischofer

> Sent: Friday, April 21, 2017 5:25 PM

> To: lng-odp@lists.linaro.org

> Subject: [lng-odp] [API-NEXT PATCHv3 1/6] api: classification: add

> additional doxygen documentation

> 

> 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(+)

> 

> diff --git a/include/odp/api/spec/classification.h

> b/include/odp/api/spec/classification.h

> index 0e1addd6..39831b24 100644

> --- a/include/odp/api/spec/classification.h

> +++ b/include/odp/api/spec/classification.h

> @@ -366,7 +366,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;

> @@ -374,6 +376,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 */

> --

> 2.11.0

Patch hide | download patch | download mbox

diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h
index 0e1addd6..39831b24 100644
--- a/include/odp/api/spec/classification.h
+++ b/include/odp/api/spec/classification.h
@@ -366,7 +366,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;
@@ -374,6 +376,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 */