* [PATCH] doc: fix doxygen parsing of __attribute__
@ 2013-11-05 11:14 Thomas Monjalon
[not found] ` <1383650075-30182-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
0 siblings, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2013-11-05 11:14 UTC (permalink / raw)
To: dev-VfR2kkLFssw
Ignore __attribute__ because it was wrongly parsed as an identifier.
Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
---
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
^ permalink raw reply related [flat|nested] 4+ messages in thread[parent not found: <1383650075-30182-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>]
* Re: [PATCH] doc: fix doxygen parsing of __attribute__ [not found] ` <1383650075-30182-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org> @ 2013-11-07 9:27 ` Olivier MATZ [not found] ` <527B5CFB.9000904-pdR9zngts4EAvxtiuMwx3w@public.gmane.org> 0 siblings, 1 reply; 4+ messages in thread From: Olivier MATZ @ 2013-11-07 9:27 UTC (permalink / raw) To: Thomas Monjalon; +Cc: dev-VfR2kkLFssw 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 ^ permalink raw reply [flat|nested] 4+ messages in thread
[parent not found: <527B5CFB.9000904-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>]
* Re: [PATCH] doc: fix doxygen parsing of __attribute__ [not found] ` <527B5CFB.9000904-pdR9zngts4EAvxtiuMwx3w@public.gmane.org> @ 2013-11-07 9:29 ` Olivier MATZ 2013-11-07 10:56 ` Thomas Monjalon 1 sibling, 0 replies; 4+ messages in thread From: Olivier MATZ @ 2013-11-07 9:29 UTC (permalink / raw) To: Thomas Monjalon; +Cc: dev-VfR2kkLFssw > > 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... ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] doc: fix doxygen parsing of __attribute__ [not found] ` <527B5CFB.9000904-pdR9zngts4EAvxtiuMwx3w@public.gmane.org> 2013-11-07 9:29 ` Olivier MATZ @ 2013-11-07 10:56 ` Thomas Monjalon 1 sibling, 0 replies; 4+ messages in thread From: Thomas Monjalon @ 2013-11-07 10:56 UTC (permalink / raw) To: Olivier MATZ; +Cc: dev-VfR2kkLFssw 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 ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2013-11-07 10:56 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-11-05 11:14 [PATCH] doc: fix doxygen parsing of __attribute__ Thomas Monjalon
[not found] ` <1383650075-30182-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
2013-11-07 9:27 ` Olivier MATZ
[not found] ` <527B5CFB.9000904-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
2013-11-07 9:29 ` Olivier MATZ
2013-11-07 10:56 ` Thomas Monjalon
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).