diff mbox

linux-generic: config: add missing doxygen documentation for abi macros

Message ID 1476878971-2094-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit c710eb38a88d20f4adc2ee377a0fa170fbca1aca
Headers show

Commit Message

Bill Fischofer Oct. 19, 2016, 12:09 p.m. UTC
Fix Bug https://bugs.linaro.org/show_bug.cgi?id=2553 by adding missing
doxygen documentation for the internal macros ODP_ABI_COMPAT and _STATIC.

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

---
 .../linux-generic/include/odp/api/plat/static_inline.h.in     | 11 +++++++++++
 1 file changed, 11 insertions(+)

-- 
2.7.4

Comments

Mike Holmes Oct. 19, 2016, 3:01 p.m. UTC | #1
On 19 October 2016 at 08:09, Bill Fischofer <bill.fischofer@linaro.org> wrote:
> Fix Bug https://bugs.linaro.org/show_bug.cgi?id=2553 by adding missing

> doxygen documentation for the internal macros ODP_ABI_COMPAT and _STATIC.

>

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


Reviewed-by: Mike Holmes <mike.holmes@linaro.org>



> ---

>  .../linux-generic/include/odp/api/plat/static_inline.h.in     | 11 +++++++++++

>  1 file changed, 11 insertions(+)

>

> diff --git a/platform/linux-generic/include/odp/api/plat/static_inline.h.in b/platform/linux-generic/include/odp/api/plat/static_inline.h.in

> index acee5f3..4562a22 100644

> --- a/platform/linux-generic/include/odp/api/plat/static_inline.h.in

> +++ b/platform/linux-generic/include/odp/api/plat/static_inline.h.in

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

>  extern "C" {

>  #endif

>

> +/**

> + * @internal

> + * @def ODP_ABI_COMPAT

> + * Control ABI compatibility

> + */

> +

> +/**

> + * @internal

> + * @def _STATIC

> + * Control conditional static inline expansions for ABI compatibility

> + */

>  #if @ODP_ABI_COMPAT@

>  #define ODP_ABI_COMPAT 1

>  #define _STATIC

> --

> 2.7.4

>




-- 
Mike Holmes
Program Manager - Linaro Networking Group
Linaro.org │ Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
Maxim Uvarov Oct. 27, 2016, 1:02 p.m. UTC | #2
Merged,
Maxim.

On 10/19/16 18:01, Mike Holmes wrote:
> On 19 October 2016 at 08:09, Bill Fischofer <bill.fischofer@linaro.org> wrote:

>> Fix Bug https://bugs.linaro.org/show_bug.cgi?id=2553 by adding missing

>> doxygen documentation for the internal macros ODP_ABI_COMPAT and _STATIC.

>>

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

> Reviewed-by: Mike Holmes <mike.holmes@linaro.org>

>

>

>> ---

>>   .../linux-generic/include/odp/api/plat/static_inline.h.in     | 11 +++++++++++

>>   1 file changed, 11 insertions(+)

>>

>> diff --git a/platform/linux-generic/include/odp/api/plat/static_inline.h.in b/platform/linux-generic/include/odp/api/plat/static_inline.h.in

>> index acee5f3..4562a22 100644

>> --- a/platform/linux-generic/include/odp/api/plat/static_inline.h.in

>> +++ b/platform/linux-generic/include/odp/api/plat/static_inline.h.in

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

>>   extern "C" {

>>   #endif

>>

>> +/**

>> + * @internal

>> + * @def ODP_ABI_COMPAT

>> + * Control ABI compatibility

>> + */

>> +

>> +/**

>> + * @internal

>> + * @def _STATIC

>> + * Control conditional static inline expansions for ABI compatibility

>> + */

>>   #if @ODP_ABI_COMPAT@

>>   #define ODP_ABI_COMPAT 1

>>   #define _STATIC

>> --

>> 2.7.4

>>

>

>
diff mbox

Patch

diff --git a/platform/linux-generic/include/odp/api/plat/static_inline.h.in b/platform/linux-generic/include/odp/api/plat/static_inline.h.in
index acee5f3..4562a22 100644
--- a/platform/linux-generic/include/odp/api/plat/static_inline.h.in
+++ b/platform/linux-generic/include/odp/api/plat/static_inline.h.in
@@ -17,6 +17,17 @@ 
 extern "C" {
 #endif
 
+/**
+ * @internal
+ * @def ODP_ABI_COMPAT
+ * Control ABI compatibility
+ */
+
+/**
+ * @internal
+ * @def _STATIC
+ * Control conditional static inline expansions for ABI compatibility
+ */
 #if @ODP_ABI_COMPAT@
 #define ODP_ABI_COMPAT 1
 #define _STATIC