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

Olivier MATZ olivier.matz at 6wind.com
Thu Nov 7 10:27:23 CET 2013


Hi Thomas,

 > Ignore __attribute__ because it was wrongly parsed as an identifier.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon at 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



More information about the dev mailing list