Add missing doxygen todo tags

From: mike-holmes <mike.holmes@linaro.org>

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 include/odp_ring.h                                   | 6 ++++--
 platform/linux-generic/Doxyfile.in                   | 2 +-
 platform/linux-generic/include/odp_buffer_internal.h | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

Hi,

Mike, we should stick with single way of doxygen tagging. You are using '\' 
and where as majority of tags are '@'. E.g. I find the '@' much more 
readable ( /**\xyz  vs /** @xyz ). Could we standardize on that? Could you 
find all '\' tags and replace with '@' ?

Thanks,

Petri
 



On Thursday, 20 March 2014 04:32:18 UTC+2, Mike Holmes wrote:

> From: mike-holmes <mike....@linaro.org <javascript:>> 
>
> Signed-off-by: Mike Holmes <mike....@linaro.org <javascript:>> 
> --- 
>  include/odp_ring.h                                   | 6 ++++-- 
>  platform/linux-generic/Doxyfile.in                   | 2 +- 
>  platform/linux-generic/include/odp_buffer_internal.h | 2 +- 
>  3 files changed, 6 insertions(+), 4 deletions(-) 
>
> diff --git a/include/odp_ring.h b/include/odp_ring.h 
> index 7ba1ca9..134ae48 100644 
> --- a/include/odp_ring.h 
> +++ b/include/odp_ring.h 
> @@ -37,7 +37,9 @@ 
>   
> ***************************************************************************/ 
>
>   
>  /** 
> - * ODP Ring 
> + * @file 
> + * 
> + * ODP Ring Helper 
>   * 
>   * The Ring Manager is a fixed-size queue, implemented as a table of 
>   * pointers. Head and tail pointers are modified atomically, allowing 
> @@ -324,7 +326,7 @@ unsigned odp_ring_free_count(const odp_ring_t *r); 
>   */ 
>  odp_ring_t *odp_ring_lookup(const char *name); 
>   
> -/*todo: dump the status of all rings on the console */ 
> +/**\todo: dump the status of all rings on the console */ 
>


@todo instead of \todo, etc..


 

>  void odp_ring_list_dump(void); 
>   
>  #ifdef __cplusplus 
> diff --git a/platform/linux-generic/Doxyfile.in 
> b/platform/linux-generic/Doxyfile.in 
> index 421e7ac..b1c46ab 100644 
> --- a/platform/linux-generic/Doxyfile.in 
> +++ b/platform/linux-generic/Doxyfile.in 
> @@ -9,7 +9,7 @@ TYPEDEF_HIDES_STRUCT = YES 
>  EXTRACT_STATIC = YES 
>  SORT_MEMBER_DOCS = NO 
>  WARN_NO_PARAMDOC = YES 
> -INPUT = ../../include  ../../test 
> +INPUT = ../../include ../../include/helper ./include  ../../test 
>  FILE_PATTERNS = odp*.h odp*.c 
>  RECURSIVE = YES 
>  SOURCE_BROWSER = YES 
> diff --git a/platform/linux-generic/include/odp_buffer_internal.h 
> b/platform/linux-generic/include/odp_buffer_internal.h 
> index c4e5b33..3930dc2 100644 
> --- a/platform/linux-generic/include/odp_buffer_internal.h 
> +++ b/platform/linux-generic/include/odp_buffer_internal.h 
> @@ -25,7 +25,7 @@ extern "C" { 
>  #include <odp_debug.h> 
>  #include <odp_align.h> 
>   
> -/* TODO: move these to correct files */ 
> +/** \todo move these to correct files */ 
>   
>  typedef uint64_t odp_phys_addr_t; 
>   
> -- 
> 1.9.1 
>
>

Sure, old habits, I will re send.

Mike


On 20 March 2014 03:49, Petri Savolainen <petri.savolainen@linaro.org>wrote:

> Hi,
>
> Mike, we should stick with single way of doxygen tagging. You are using
> '\' and where as majority of tags are '@'. E.g. I find the '@' much more
> readable ( /**\xyz  vs /** @xyz ). Could we standardize on that? Could you
> find all '\' tags and replace with '@' ?
>
> Thanks,
>
> Petri
>
>
>
>
> On Thursday, 20 March 2014 04:32:18 UTC+2, Mike Holmes wrote:
>
>> From: mike-holmes <mike....@linaro.org>
>>
>> Signed-off-by: Mike Holmes <mike....@linaro.org>
>> ---
>>  include/odp_ring.h                                   | 6 ++++--
>>  platform/linux-generic/Doxyfile.in                   | 2 +-
>>  platform/linux-generic/include/odp_buffer_internal.h | 2 +-
>>  3 files changed, 6 insertions(+), 4 deletions(-)
>>
>> diff --git a/include/odp_ring.h b/include/odp_ring.h
>> index 7ba1ca9..134ae48 100644
>> --- a/include/odp_ring.h
>> +++ b/include/odp_ring.h
>> @@ -37,7 +37,9 @@
>>   ***************************************************************************/
>>
>>
>>  /**
>> - * ODP Ring
>> + * @file
>> + *
>> + * ODP Ring Helper
>>   *
>>   * The Ring Manager is a fixed-size queue, implemented as a table of
>>   * pointers. Head and tail pointers are modified atomically, allowing
>> @@ -324,7 +326,7 @@ unsigned odp_ring_free_count(const odp_ring_t *r);
>>   */
>>  odp_ring_t *odp_ring_lookup(const char *name);
>>
>> -/*todo: dump the status of all rings on the console */
>> +/**\todo: dump the status of all rings on the console */
>>
>
>
> @todo instead of \todo, etc..
>
>
>
>
>>  void odp_ring_list_dump(void);
>>
>>  #ifdef __cplusplus
>> diff --git a/platform/linux-generic/Doxyfile.in b/platform/linux-generic/Doxyfile.in
>>
>> index 421e7ac..b1c46ab 100644
>> --- a/platform/linux-generic/Doxyfile.in
>> +++ b/platform/linux-generic/Doxyfile.in
>> @@ -9,7 +9,7 @@ TYPEDEF_HIDES_STRUCT = YES
>>  EXTRACT_STATIC = YES
>>  SORT_MEMBER_DOCS = NO
>>  WARN_NO_PARAMDOC = YES
>> -INPUT = ../../include  ../../test
>> +INPUT = ../../include ../../include/helper ./include  ../../test
>>  FILE_PATTERNS = odp*.h odp*.c
>>  RECURSIVE = YES
>>  SOURCE_BROWSER = YES
>> diff --git a/platform/linux-generic/include/odp_buffer_internal.h
>> b/platform/linux-generic/include/odp_buffer_internal.h
>> index c4e5b33..3930dc2 100644
>> --- a/platform/linux-generic/include/odp_buffer_internal.h
>> +++ b/platform/linux-generic/include/odp_buffer_internal.h
>> @@ -25,7 +25,7 @@ extern "C" {
>>  #include <odp_debug.h>
>>  #include <odp_align.h>
>>
>> -/* TODO: move these to correct files */
>> +/** \todo move these to correct files */
>>
>>  typedef uint64_t odp_phys_addr_t;
>>
>> --
>> 1.9.1
>>
>>