diff mbox

[API-NEXT,PATCHv4,1/3] linux-generic: config: add missing syntax to enable doxygen

Message ID 1446037401-20990-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit b28398a028565ba447c8044ab2273137e76c9668
Headers show

Commit Message

Bill Fischofer Oct. 28, 2015, 1:03 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. 28, 2015, 3:48 p.m. UTC | #1
Merged to api-next.

Maxim.

On 10/28/2015 16:09, Savolainen, Petri (Nokia - FI/Espoo) wrote:
> Entire patch set:
>
> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
>
>
>
>> -----Original Message-----
>> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of EXT
>> Bill Fischofer
>> Sent: Wednesday, October 28, 2015 3:03 PM
>> To: lng-odp@lists.linaro.org
>> Subject: [lng-odp] [API-NEXT PATCHv4 1/3] linux-generic: config: add
>> missing syntax to enable doxygen
>>
>> 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..ee23df3 100644
>> --- a/platform/linux-generic/include/odp/config.h
>> +++ b/platform/linux-generic/include/odp/config.h
>> @@ -17,6 +17,11 @@
>>   extern "C" {
>>   #endif
>>
>> +/** @ingroup 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
>> --
>> 2.1.4
>>
>> _______________________________________________
>> lng-odp mailing list
>> lng-odp@lists.linaro.org
>> https://lists.linaro.org/mailman/listinfo/lng-odp
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/platform/linux-generic/include/odp/config.h b/platform/linux-generic/include/odp/config.h
index a130e68..ee23df3 100644
--- a/platform/linux-generic/include/odp/config.h
+++ b/platform/linux-generic/include/odp/config.h
@@ -17,6 +17,11 @@ 
 extern "C" {
 #endif
 
+/** @ingroup 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