[MONARCH_LTS,4/5] linux-generic: types: add additional doxygen documentation

Message ID 20170712014545.13325-4-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>

---
 platform/linux-generic/include/odp/api/plat/buffer_types.h    | 11 ++++++++++-
 platform/linux-generic/include/odp/api/plat/pool_types.h      | 11 ++++++++++-
 .../linux-generic/include/odp/api/plat/traffic_mngr_types.h   |  2 +-
 3 files changed, 21 insertions(+), 3 deletions(-)

-- 
2.11.0

Patch

diff --git a/platform/linux-generic/include/odp/api/plat/buffer_types.h b/platform/linux-generic/include/odp/api/plat/buffer_types.h
index 344121b6..079f5aaa 100644
--- a/platform/linux-generic/include/odp/api/plat/buffer_types.h
+++ b/platform/linux-generic/include/odp/api/plat/buffer_types.h
@@ -32,7 +32,16 @@  typedef ODP_HANDLE_T(odp_buffer_seg_t);
 /** Invalid segment */
 #define ODP_SEGMENT_INVALID ((odp_buffer_seg_t)ODP_BUFFER_INVALID)
 
-/** Get printable format of odp_buffer_t */
+/** Get printable format of odp_buffer_t
+ *
+ * @param hdl  odp_buffer_t handle to be printed
+ * @return     uint64_t value that can be used to print/display this
+ *             handle
+ *
+ * @note This routine is intended to be used for diagnostic purposes
+ * to enable applications to generate a printable value that represents
+ * an odp_buffer_t handle.
+ */
 static inline uint64_t odp_buffer_to_u64(odp_buffer_t hdl)
 {
 	return _odp_pri(hdl);
diff --git a/platform/linux-generic/include/odp/api/plat/pool_types.h b/platform/linux-generic/include/odp/api/plat/pool_types.h
index 1ca8f02e..c466dcbb 100644
--- a/platform/linux-generic/include/odp/api/plat/pool_types.h
+++ b/platform/linux-generic/include/odp/api/plat/pool_types.h
@@ -39,7 +39,16 @@  typedef enum odp_pool_type_t {
 	ODP_POOL_TIMEOUT = ODP_EVENT_TIMEOUT,
 } odp_pool_type_t;
 
-/** Get printable format of odp_pool_t */
+/** Get printable format of odp_pool_t
+ *
+ * @param hdl  odp_pool_t handle to be printed
+ * @return     uint64_t value that can be used to print/display this
+ *             handle
+ *
+ * @note This routine is intended to be used for diagnostic purposes
+ * to enable applications to generate a printable value that represents
+ * an odp_pool_t handle.
+ */
 static inline uint64_t odp_pool_to_u64(odp_pool_t hdl)
 {
 	return _odp_pri(hdl);
diff --git a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
index b766afec..f47a13f6 100644
--- a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
+++ b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
@@ -168,7 +168,7 @@  typedef odp_tm_handle_t odp_tm_wred_t;
  */
 #define ODP_TM_ROOT  ((odp_tm_handle_t)-1)
 
-/** Get printable format of odp_queue_t */
+/** @internal Get printable format of odp_tm_handle_t @param hdl @return */
 static inline uint64_t odp_tm_handle_to_u64(odp_tm_handle_t hdl)
 {
 	return hdl;