diff mbox

doxygen: init: odp_init_t

Message ID 1422633716-25375-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit aed53b3007934c8b28b5d94e88f58148532d0a63
Headers show

Commit Message

Mike Holmes Jan. 30, 2015, 4:01 p.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 include/odp/api/init.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Anders Roxell Feb. 2, 2015, 9 p.m. UTC | #1
On 2015-01-30 11:01, Mike Holmes wrote:
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>

> ---
>  include/odp/api/init.h | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/include/odp/api/init.h b/include/odp/api/init.h
> index c73b321..6b33987 100644
> --- a/include/odp/api/init.h
> +++ b/include/odp/api/init.h
> @@ -79,9 +79,11 @@ typedef int (*odp_log_func_t)(odp_log_level_e level, const char *fmt, ...);
>   * Data that is required to initialize the ODP API with the
>   * application specific data such as specifying a logging callback, the log
>   * level etc.
> + *
> + * @note it is expected that all unassigned members are zero
>   */
>  typedef struct odp_init_t {
> -	odp_log_func_t log_fn;
> +	odp_log_func_t log_fn; /**< Replacement for the default log fn */

This can be fixed when pushing the patch I think, change "fn" to "function".

Cheers,
Anders
Anders Roxell Feb. 2, 2015, 9:16 p.m. UTC | #2
On 2 February 2015 at 22:00, Anders Roxell <anders.roxell@linaro.org> wrote:
> On 2015-01-30 11:01, Mike Holmes wrote:
>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>

urgh... meant

Reviewed-by: Anders Roxell <anders.roxell@linaro.org>

>
>> ---
>>  include/odp/api/init.h | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/include/odp/api/init.h b/include/odp/api/init.h
>> index c73b321..6b33987 100644
>> --- a/include/odp/api/init.h
>> +++ b/include/odp/api/init.h
>> @@ -79,9 +79,11 @@ typedef int (*odp_log_func_t)(odp_log_level_e level, const char *fmt, ...);
>>   * Data that is required to initialize the ODP API with the
>>   * application specific data such as specifying a logging callback, the log
>>   * level etc.
>> + *
>> + * @note it is expected that all unassigned members are zero
>>   */
>>  typedef struct odp_init_t {
>> -     odp_log_func_t log_fn;
>> +     odp_log_func_t log_fn; /**< Replacement for the default log fn */
>
> This can be fixed when pushing the patch I think, change "fn" to "function".
>
> Cheers,
> Anders
diff mbox

Patch

diff --git a/include/odp/api/init.h b/include/odp/api/init.h
index c73b321..6b33987 100644
--- a/include/odp/api/init.h
+++ b/include/odp/api/init.h
@@ -79,9 +79,11 @@  typedef int (*odp_log_func_t)(odp_log_level_e level, const char *fmt, ...);
  * Data that is required to initialize the ODP API with the
  * application specific data such as specifying a logging callback, the log
  * level etc.
+ *
+ * @note it is expected that all unassigned members are zero
  */
 typedef struct odp_init_t {
-	odp_log_func_t log_fn;
+	odp_log_func_t log_fn; /**< Replacement for the default log fn */
 } odp_init_t;
 
 /** ODP platform initialization data.