diff mbox

[API-NEXT] linux-generic: config: add missing syntax to enable doxygen

Message ID 1445607399-14189-1-git-send-email-bill.fischofer@linaro.org
State Superseded
Headers show

Commit Message

Bill Fischofer Oct. 23, 2015, 1:36 p.m. UTC
Enable doxygen to document platform-specific config values

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 platform/linux-generic/include/odp/config.h | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Maxim Uvarov Oct. 26, 2015, 1:28 p.m. UTC | #1
Bill,

looks like this fix is not compile. In generated api doc there are 
#defines as well as config functions.
In my understanding api is only function, not defines for config.

Maxim.

On 10/23/2015 16:36, Bill Fischofer wrote:
> Enable doxygen to document platform-specific config values
>
> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
> ---
>   platform/linux-generic/include/odp/config.h | 9 +++++++++
>   1 file changed, 9 insertions(+)
>
> diff --git a/platform/linux-generic/include/odp/config.h b/platform/linux-generic/include/odp/config.h
> index a130e68..d800914 100644
> --- a/platform/linux-generic/include/odp/config.h
> +++ b/platform/linux-generic/include/odp/config.h
> @@ -17,6 +17,11 @@
>   extern "C" {
>   #endif
>   
> +/** @defgroup odp_config ODP CONFIG
> + * Platform-specific configuration limits
> + * @{
> + */
> +
>   /**
>    * Maximum number of pools
>    */
> @@ -184,6 +189,10 @@ static inline int odp_config_shm_blocks(void)
>   
>   #include <odp/api/config.h>
>   
> +/**
> + * @}
> + */
> +
>   #ifdef __cplusplus
>   }
>   #endif
Bill Fischofer Oct. 26, 2015, 1:38 p.m. UTC | #2
It may require a rebase?  It was compiling just fine when I submitted it.

I'll investigate and issue a v2 if needed.

Bill

On Mon, Oct 26, 2015 at 8:28 AM, Maxim Uvarov <maxim.uvarov@linaro.org>
wrote:

> Bill,

>

> looks like this fix is not compile. In generated api doc there are

> #defines as well as config functions.

> In my understanding api is only function, not defines for config.

>

> Maxim.

>

>

> On 10/23/2015 16:36, Bill Fischofer wrote:

>

>> Enable doxygen to document platform-specific config values

>>

>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>> ---

>>   platform/linux-generic/include/odp/config.h | 9 +++++++++

>>   1 file changed, 9 insertions(+)

>>

>> diff --git a/platform/linux-generic/include/odp/config.h

>> b/platform/linux-generic/include/odp/config.h

>> index a130e68..d800914 100644

>> --- a/platform/linux-generic/include/odp/config.h

>> +++ b/platform/linux-generic/include/odp/config.h

>> @@ -17,6 +17,11 @@

>>   extern "C" {

>>   #endif

>>   +/** @defgroup odp_config ODP CONFIG

>> + * Platform-specific configuration limits

>> + * @{

>> + */

>> +

>>   /**

>>    * Maximum number of pools

>>    */

>> @@ -184,6 +189,10 @@ static inline int odp_config_shm_blocks(void)

>>     #include <odp/api/config.h>

>>   +/**

>> + * @}

>> + */

>> +

>>   #ifdef __cplusplus

>>   }

>>   #endif

>>

>

>
diff mbox

Patch

diff --git a/platform/linux-generic/include/odp/config.h b/platform/linux-generic/include/odp/config.h
index a130e68..d800914 100644
--- a/platform/linux-generic/include/odp/config.h
+++ b/platform/linux-generic/include/odp/config.h
@@ -17,6 +17,11 @@ 
 extern "C" {
 #endif
 
+/** @defgroup odp_config ODP CONFIG
+ * Platform-specific configuration limits
+ * @{
+ */
+
 /**
  * Maximum number of pools
  */
@@ -184,6 +189,10 @@  static inline int odp_config_shm_blocks(void)
 
 #include <odp/api/config.h>
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif