[API-NEXT,PATCHv3,5/6] linux-generic: types: add additional doxygen documentation

Message ID 1492784725-31626-5-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit af05215e26c99693c000981fddfaf3cdd2225e3f
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>

---
 platform/linux-generic/include/odp/api/debug.h                   | 8 ++++++++
 platform/linux-generic/include/odp/api/plat/packet_types.h       | 1 +
 platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +-
 3 files changed, 10 insertions(+), 1 deletion(-)

-- 
2.11.0

Patch

diff --git a/platform/linux-generic/include/odp/api/debug.h b/platform/linux-generic/include/odp/api/debug.h
index b0f91b1c..bef2fd0e 100644
--- a/platform/linux-generic/include/odp/api/debug.h
+++ b/platform/linux-generic/include/odp/api/debug.h
@@ -25,17 +25,23 @@  extern "C" {
  * versions.
  */
 #define _odp_merge(a, b) a##b
+/** @internal */
 #define _odp_label(a) _odp_merge(_ODP_SASSERT_, a)
+/** @internal */
 #define _ODP_SASSERT _odp_label(__COUNTER__)
+/** @internal */
 #define _ODP_SASSERT_ENUM(e) { _ODP_SASSERT = 1 / !!(e) }
+/** @internal */
 #define _odp_static_assert(e, s) enum _ODP_SASSERT_ENUM(e)
 
 #if defined(__clang__)
 #if defined(__cplusplus)
 #if !__has_feature(cxx_static_assert) && !defined(static_assert)
+/** @internal */
 #define	static_assert(e, s) _odp_static_assert(e, s)
 #endif
 #elif !__has_feature(c_static_assert) && !defined(_Static_assert)
+/** @internal */
 #define _Static_assert(e, s) _odp_static_assert(e, s)
 #endif
 
@@ -44,9 +50,11 @@  extern "C" {
 	(__GNUC__ < 6 && defined(__cplusplus))
 #if defined(__cplusplus)
 #if !defined(static_assert)
+/** @intenral */
 #define	static_assert(e, s) _odp_static_assert(e, s)
 #endif
 #elif !defined(_Static_assert)
+/** @internal */
 #define _Static_assert(e, s) _odp_static_assert(e, s)
 #endif
 #endif
diff --git a/platform/linux-generic/include/odp/api/plat/packet_types.h b/platform/linux-generic/include/odp/api/plat/packet_types.h
index 7403afc1..a209c759 100644
--- a/platform/linux-generic/include/odp/api/plat/packet_types.h
+++ b/platform/linux-generic/include/odp/api/plat/packet_types.h
@@ -105,6 +105,7 @@  typedef union {
 	/** All input flags */
 	uint64_t all;
 
+	/** Individual input flags */
 	struct {
 		uint64_t dst_queue:1; /**< Dst queue present */
 
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;