[dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__

[dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__

[Thomas Monjalon]

Ignore __attribute__ because it was wrongly parsed as an identifier.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 doc/doxy-api.conf |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index 7ea692a..749db78 100644
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -47,9 +47,13 @@ INPUT                   = doc/doxy-api-index.md \
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
 PREDEFINED              = __DOXYGEN__ \
+                          __attribute__(x)= \
                           RTE_MBUF_SCATTER_GATHER
 
 OPTIMIZE_OUTPUT_FOR_C   = YES
+ENABLE_PREPROCESSING    = YES
+MACRO_EXPANSION         = YES
+EXPAND_ONLY_PREDEF      = YES
 EXTRACT_STATIC          = YES
 HIDE_UNDOC_MEMBERS      = YES
 HIDE_UNDOC_CLASSES      = YES
-- 
1.7.10.4

Re: [dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__

[Olivier MATZ]

Hi Thomas,

 > Ignore __attribute__ because it was wrongly parsed as an identifier.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

What about prefixing the title by "doc: " and remove the dot at the
end of the line ?

> --- a/doc/doxy-api.conf
> +++ b/doc/doxy-api.conf
> @@ -47,9 +47,13 @@ INPUT                   = doc/doxy-api-index.md \
>   FILE_PATTERNS           = rte_*.h \
>                             cmdline.h
>   PREDEFINED              = __DOXYGEN__ \
> +                          __attribute__(x)= \
>                             RTE_MBUF_SCATTER_GATHER
>
>   OPTIMIZE_OUTPUT_FOR_C   = YES
> +ENABLE_PREPROCESSING    = YES
> +MACRO_EXPANSION         = YES
> +EXPAND_ONLY_PREDEF      = YES
>   EXTRACT_STATIC          = YES
>   HIDE_UNDOC_MEMBERS      = YES
>   HIDE_UNDOC_CLASSES      = YES

I think you should provide a pointer to the doxygen documentation
in the commit log to explain the modification. Maybe this one is
appropriate:
http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html

About the patch itself, it looks good to me.

Olivier

Re: [dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__

[Olivier MATZ]

>  > Ignore __attribute__ because it was wrongly parsed as an identifier.
>
> What about prefixing the title by "doc: " and remove the dot at the
> end of the line ?

Sorry, please ignore my first comment, it was not the title...

Re: [dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__

[Thomas Monjalon]

07/11/2013 10:27, Olivier MATZ :
> I think you should provide a pointer to the doxygen documentation
> in the commit log to explain the modification. Maybe this one is
> appropriate:
> http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html
> 
> About the patch itself, it looks good to me.

Thanks for your comment.

It is pushed.

-- 
Thomas