diff mbox

helper: linux: doxygen: group linux api

Message ID 1429299227-30008-1-git-send-email-mike.holmes@linaro.org
State New
Headers show

Commit Message

Mike Holmes April 17, 2015, 7:33 p.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 helper/include/odp/helper/linux.h | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Anders Roxell April 20, 2015, 7:26 p.m. UTC | #1
On 2015-04-17 15:33, Mike Holmes wrote:
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>  helper/include/odp/helper/linux.h | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/helper/include/odp/helper/linux.h b/helper/include/odp/helper/linux.h
> index 146e26c..b4f011b 100644
> --- a/helper/include/odp/helper/linux.h
> +++ b/helper/include/odp/helper/linux.h
> @@ -27,6 +27,11 @@ extern "C" {
>  #include <pthread.h>
>  #include <sys/types.h>
>  
> +
> +/** @addtogroup odph_linux ODPH LINUX

Can we add some description here?

Cheers,
Anders

> + *  @{
> + */
> +
>  /** The thread starting arguments */
>  typedef struct {
>  	void *(*start_routine) (void *); /**< The function to run */
> @@ -129,6 +134,9 @@ int odph_linux_process_fork_n(odph_linux_process_t *proc_tbl,
>   */
>  int odph_linux_process_wait_n(odph_linux_process_t *proc_tbl, int num);
>  
> +/**
> + * @}
> + */
>  
>  #ifdef __cplusplus
>  }
> -- 
> 2.1.0
> 
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/helper/include/odp/helper/linux.h b/helper/include/odp/helper/linux.h
index 146e26c..b4f011b 100644
--- a/helper/include/odp/helper/linux.h
+++ b/helper/include/odp/helper/linux.h
@@ -27,6 +27,11 @@  extern "C" {
 #include <pthread.h>
 #include <sys/types.h>
 
+
+/** @addtogroup odph_linux ODPH LINUX
+ *  @{
+ */
+
 /** The thread starting arguments */
 typedef struct {
 	void *(*start_routine) (void *); /**< The function to run */
@@ -129,6 +134,9 @@  int odph_linux_process_fork_n(odph_linux_process_t *proc_tbl,
  */
 int odph_linux_process_wait_n(odph_linux_process_t *proc_tbl, int num);
 
+/**
+ * @}
+ */
 
 #ifdef __cplusplus
 }