[MONARCH_LTS,2/5] api: pool: add additional doxygen documentation

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

-- 
2.11.0

Patch

diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h
index b31b6aa8..10bcbd51 100644
--- a/include/odp/api/spec/pool.h
+++ b/include/odp/api/spec/pool.h
@@ -164,7 +164,9 @@  typedef struct odp_pool_param_t {
 	/** Pool type */
 	int type;
 
+	/** Variant parameters for different pool types */
 	union {
+		/** Parameters for buffer pools */
 		struct {
 			/** Number of buffers in the pool */
 			uint32_t num;
@@ -178,6 +180,8 @@  typedef struct odp_pool_param_t {
 			    Default will always be a multiple of 8. */
 			uint32_t align;
 		} buf;
+
+		/** Parameters for packet pools */
 		struct {
 			/** The number of packets that the pool must provide
 			    that are packet length 'len' bytes or smaller.
@@ -203,6 +207,8 @@  typedef struct odp_pool_param_t {
 			    Specify as 0 if no user area is needed. */
 			uint32_t uarea_size;
 		} pkt;
+
+		/** Parameters for timeout pools */
 		struct {
 			/** Number of timeouts in the pool */
 			uint32_t num;