From mboxrd@z Thu Jan  1 00:00:00 1970
From: Olivier MATZ <olivier.matz-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
Subject: Re: [PATCH] doc: fix doxygen parsing of __attribute__
Date: Thu, 07 Nov 2013 10:27:23 +0100
Message-ID: <527B5CFB.9000904@6wind.com>
References: <1383650075-30182-1-git-send-email-thomas.monjalon@6wind.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Cc: dev-VfR2kkLFssw@public.gmane.org
To: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
Return-path: <dev-bounces-VfR2kkLFssw@public.gmane.org>
In-Reply-To: <1383650075-30182-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request-VfR2kkLFssw@public.gmane.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev-VfR2kkLFssw@public.gmane.org>
List-Help: <mailto:dev-request-VfR2kkLFssw@public.gmane.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request-VfR2kkLFssw@public.gmane.org?subject=subscribe>
Errors-To: dev-bounces-VfR2kkLFssw@public.gmane.org
Sender: "dev" <dev-bounces-VfR2kkLFssw@public.gmane.org>

Hi Thomas,

 > Ignore __attribute__ because it was wrongly parsed as an identifier.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>

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