From: Olivier MATZ <olivier.matz@6wind.com>
To: Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] doc: fix doxygen parsing of __attribute__
Date: Thu, 07 Nov 2013 10:27:23 +0100 [thread overview]
Message-ID: <527B5CFB.9000904@6wind.com> (raw)
In-Reply-To: <1383650075-30182-1-git-send-email-thomas.monjalon@6wind.com>
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
next prev parent reply other threads:[~2013-11-07 9:26 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-05 11:14 Thomas Monjalon
2013-11-07 9:27 ` Olivier MATZ [this message]
2013-11-07 9:29 ` Olivier MATZ
2013-11-07 10:56 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=527B5CFB.9000904@6wind.com \
--to=olivier.matz@6wind.com \
--cc=dev@dpdk.org \
--cc=thomas.monjalon@6wind.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).