api: doc: re-organize doxygen doc for synchronizer

Removed module synchronizer from doxygen documentation and
introduced new modules for locks, atomics and barriers. Removed
unnecessary group tagging from internal headers, which are not
visible to doxygen anyway.

Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

14 files changed, 6 insertions, 128 deletions

diff --git a/platform/linux-generic/include/odp/atomic.h b/platform/linux-generic/include/odp/atomic.h
index e47a280bf..deb4039b3 100644
--- a/platform/linux-generic/include/odp/atomic.h
+++ b/platform/linux-generic/include/odp/atomic.h
@@ -21,7 +21,7 @@ extern "C" {
 #include <odp/align.h>
 #include <odp/plat/atomic_types.h>
 
-/** @ingroup odp_synchronizers
+/** @ingroup odp_atomic
  *  @{
  */
 
diff --git a/platform/linux-generic/include/odp/barrier.h b/platform/linux-generic/include/odp/barrier.h
index 7ea5a6b99..42df8595a 100644
--- a/platform/linux-generic/include/odp/barrier.h
+++ b/platform/linux-generic/include/odp/barrier.h
@@ -21,14 +21,6 @@ extern "C" {
 #include <odp/plat/shared_memory_types.h>
 #include <odp/plat/barrier_types.h>
 
-/** @ingroup odp_synchronizers
- *  @{
- */
-
-/**
- * @}
- */
-
 #include <odp/api/barrier.h>
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/odp/plat/atomic_types.h b/platform/linux-generic/include/odp/plat/atomic_types.h
index 3cdcab8bd..0f6c353a1 100644
--- a/platform/linux-generic/include/odp/plat/atomic_types.h
+++ b/platform/linux-generic/include/odp/plat/atomic_types.h
@@ -62,18 +62,10 @@ struct odp_atomic_u32_s {
 })
 #endif
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_atomic_u64_s odp_atomic_u64_t;
 
 typedef struct odp_atomic_u32_s odp_atomic_u32_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/barrier_types.h b/platform/linux-generic/include/odp/plat/barrier_types.h
index c8c978dca..b8e1d97bb 100644
--- a/platform/linux-generic/include/odp/plat/barrier_types.h
+++ b/platform/linux-generic/include/odp/plat/barrier_types.h
@@ -30,16 +30,8 @@ struct odp_barrier_s {
 	odp_atomic_u32_t bar;    /**< Barrier counter */
 };
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_barrier_s odp_barrier_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/rwlock_recursive_types.h b/platform/linux-generic/include/odp/plat/rwlock_recursive_types.h
index ee818723a..d5bfb9254 100644
--- a/platform/linux-generic/include/odp/plat/rwlock_recursive_types.h
+++ b/platform/linux-generic/include/odp/plat/rwlock_recursive_types.h
@@ -21,10 +21,7 @@ extern "C" {
 #include <odp/std_types.h>
 #include <odp_config_internal.h>
 
-/**
- * @internal
- * ODP recursive rwlock
- */
+/** @internal */
 struct odp_rwlock_recursive_s {
 	odp_rwlock_t lock;                       /**< the lock */
 	int wr_owner;                            /**< write owner thread */
@@ -32,16 +29,8 @@ struct odp_rwlock_recursive_s {
 	uint8_t  rd_cnt[_ODP_INTERNAL_MAX_THREADS]; /**< read recursion count */
 };
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_rwlock_recursive_s odp_rwlock_recursive_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/rwlock_types.h b/platform/linux-generic/include/odp/plat/rwlock_types.h
index bd46e5722..35d65decb 100644
--- a/platform/linux-generic/include/odp/plat/rwlock_types.h
+++ b/platform/linux-generic/include/odp/plat/rwlock_types.h
@@ -20,10 +20,7 @@ extern "C" {
 
 #include <odp/atomic.h>
 
-/**
- * @internal
- * ODP rwlock
- */
+/** @internal */
 struct odp_rwlock_s {
 	odp_atomic_u32_t cnt; /**< lock count
 				0 lock not taken
@@ -31,16 +28,8 @@ struct odp_rwlock_s {
 				>0 read lock(s) taken */
 };
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_rwlock_s odp_rwlock_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/spinlock_recursive_types.h b/platform/linux-generic/include/odp/plat/spinlock_recursive_types.h
index cae47a4b1..2809277bd 100644
--- a/platform/linux-generic/include/odp/plat/spinlock_recursive_types.h
+++ b/platform/linux-generic/include/odp/plat/spinlock_recursive_types.h
@@ -20,26 +20,15 @@ extern "C" {
 #include <odp/spinlock.h>
 #include <odp/std_types.h>
 
-/**
- * @internal
- * ODP recursive spinlock
- */
+/** @internal */
 struct odp_spinlock_recursive_s {
 	odp_spinlock_t lock; /**< the lock */
 	int owner;           /**< thread owning the lock */
 	uint32_t cnt;        /**< recursion count */
 };
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_spinlock_recursive_s odp_spinlock_recursive_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/spinlock_types.h b/platform/linux-generic/include/odp/plat/spinlock_types.h
index 83d306b5b..3e0231d1d 100644
--- a/platform/linux-generic/include/odp/plat/spinlock_types.h
+++ b/platform/linux-generic/include/odp/plat/spinlock_types.h
@@ -20,25 +20,13 @@ extern "C" {
 
 #include <odp/std_types.h>
 
-/**
- * @internal
- * ODP spinlock
- */
+/** @internal */
 struct odp_spinlock_s {
 	char lock;  /**< lock flag, should match odp_atomic_flag_t */
 };
 
-
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_spinlock_s odp_spinlock_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/plat/ticketlock_types.h b/platform/linux-generic/include/odp/plat/ticketlock_types.h
index be9308556..73f970542 100644
--- a/platform/linux-generic/include/odp/plat/ticketlock_types.h
+++ b/platform/linux-generic/include/odp/plat/ticketlock_types.h
@@ -20,25 +20,14 @@ extern "C" {
 
 #include <odp/atomic.h>
 
-/**
- * @internal
- * ODP ticketlock
- */
+/** @internal */
 struct odp_ticketlock_s {
 	odp_atomic_u32_t  next_ticket; /**< Next ticket */
 	odp_atomic_u32_t  cur_ticket;  /**< Current ticket */
 };
 
-/** @addtogroup odp_synchronizers
- *  @{
- */
-
 typedef struct odp_ticketlock_s odp_ticketlock_t;
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif
diff --git a/platform/linux-generic/include/odp/rwlock.h b/platform/linux-generic/include/odp/rwlock.h
index ca88ff7db..f9d8f5fd4 100644
--- a/platform/linux-generic/include/odp/rwlock.h
+++ b/platform/linux-generic/include/odp/rwlock.h
@@ -19,14 +19,6 @@ extern "C" {
 
 #include <odp/plat/rwlock_types.h>
 
-/** @ingroup odp_synchronizers
- *  @{
- */
-
-/**
- * @}
- */
-
 #include <odp/api/rwlock.h>
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/odp/spinlock.h b/platform/linux-generic/include/odp/spinlock.h
index 7dbb1c4bf..046fcfada 100644
--- a/platform/linux-generic/include/odp/spinlock.h
+++ b/platform/linux-generic/include/odp/spinlock.h
@@ -19,14 +19,6 @@ extern "C" {
 
 #include <odp/plat/spinlock_types.h>
 
-/** @ingroup odp_synchronizers
- *  @{
- */
-
-/**
- * @}
- */
-
 #include <odp/api/spinlock.h>
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/odp/sync.h b/platform/linux-generic/include/odp/sync.h
index 8cdab21ef..bc7308301 100644
--- a/platform/linux-generic/include/odp/sync.h
+++ b/platform/linux-generic/include/odp/sync.h
@@ -17,14 +17,6 @@
 extern "C" {
 #endif
 
-/** @ingroup odp_synchronizers
- *  @{
- */
-
-/**
- * @}
- */
-
 #include <odp/api/sync.h>
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/odp/ticketlock.h b/platform/linux-generic/include/odp/ticketlock.h
index 658e27fe4..d3491519a 100644
--- a/platform/linux-generic/include/odp/ticketlock.h
+++ b/platform/linux-generic/include/odp/ticketlock.h
@@ -19,15 +19,6 @@ extern "C" {
 
 #include <odp/plat/ticketlock_types.h>
 
-/** @ingroup odp_synchronizers
- *  Operations on ticket locks.
- *  @{
- */
-
-/**
- * @}
- */
-
 #include <odp/api/ticketlock.h>
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/odp_atomic_internal.h b/platform/linux-generic/include/odp_atomic_internal.h
index 06fc16b1b..ce62368e1 100644
--- a/platform/linux-generic/include/odp_atomic_internal.h
+++ b/platform/linux-generic/include/odp_atomic_internal.h
@@ -25,11 +25,6 @@
 extern "C" {
 #endif
 
-/** @addtogroup odp_synchronizers
- *  Atomic operations.
- *  @{
- */
-
 /**
  * Pointer atomic type
  */
@@ -598,10 +593,6 @@ static inline void _odp_atomic_flag_clear(_odp_atomic_flag_t *flag)
 	__atomic_clear(flag, __ATOMIC_RELEASE);
 }
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif