[dpdk-dev] [PATCH] doc: disable doxygen member sorting

[dpdk-dev] [PATCH] doc: disable doxygen member sorting

[John McNamara]

Disabled the doxygen option to sort member data so that functions
and struct memebers are listed in order of definition in the
brief and main sections.

Previously they were sorted in the brief section and were in
definition order in the main section.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/api/doxy-api.conf | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index da03e9b..50d2c15 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -77,3 +77,4 @@ ALPHABETICAL_INDEX      = NO
 HTML_TIMESTAMP          = NO
 HTML_DYNAMIC_SECTIONS   = YES
 SEARCHENGINE            = NO
+SORT_MEMBER_DOCS        = NO
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting

[Mcnamara, John]

> -----Original Message-----
> From: Mcnamara, John
> Sent: Wednesday, April 29, 2015 11:48 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John
> Subject: [PATCH] doc: disable doxygen member sorting
> 
> Disabled the doxygen option to sort member data so that functions and
> struct memebers are listed in order of definition in the brief and main
> sections.



See for example:

    http://dpdk.org/doc/api/structlcore__config.html

The first listed member is "unsigned detected" but the first documented member is "void* volatile arg".

John.
-- 

Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting

[Butler, Siobhan A]

Thanks for making this change John - it helps with readability
Siobhan 

Acked-by Siobhan Butler <siobhan.a.butler@intel.com>

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Wednesday, April 29, 2015 11:52 AM
> To: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting
> 
> > -----Original Message-----
> > From: Mcnamara, John
> > Sent: Wednesday, April 29, 2015 11:48 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John
> > Subject: [PATCH] doc: disable doxygen member sorting
> >
> > Disabled the doxygen option to sort member data so that functions and
> > struct memebers are listed in order of definition in the brief and
> > main sections.
> 
> 
> 
> See for example:
> 
>     http://dpdk.org/doc/api/structlcore__config.html
> 
> The first listed member is "unsigned detected" but the first documented
> member is "void* volatile arg".
> 
> John.
> --
> 
> 
> 

Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting

[Jayakumar, Muthurajan]

Thanks for making this.
Acked 

Thanks 
M Jay
http://dpdk.readthedocs.org/en/latest/

-----Original Message-----
From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Butler, Siobhan A
Sent: Wednesday, April 29, 2015 6:56 AM
To: Mcnamara, John; dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting

Thanks for making this change John - it helps with readability Siobhan 

Acked-by Siobhan Butler <siobhan.a.butler@intel.com>

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Wednesday, April 29, 2015 11:52 AM
> To: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting
> 
> > -----Original Message-----
> > From: Mcnamara, John
> > Sent: Wednesday, April 29, 2015 11:48 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John
> > Subject: [PATCH] doc: disable doxygen member sorting
> >
> > Disabled the doxygen option to sort member data so that functions 
> > and struct memebers are listed in order of definition in the brief 
> > and main sections.
> 
> 
> 
> See for example:
> 
>     http://dpdk.org/doc/api/structlcore__config.html
> 
> The first listed member is "unsigned detected" but the first 
> documented member is "void* volatile arg".
> 
> John.
> --
> 
> 
> 

Re: [dpdk-dev] [PATCH] doc: disable doxygen member sorting

[Thomas Monjalon]

> > > Disabled the doxygen option to sort member data so that functions and
> > > struct memebers are listed in order of definition in the brief and
> > > main sections.
> > 
> > See for example:
> > 
> >     http://dpdk.org/doc/api/structlcore__config.html
> > 
> > The first listed member is "unsigned detected" but the first documented
> > member is "void* volatile arg".
> > 
> > John.
> 
> Thanks for making this change John - it helps with readability
> Siobhan 
> 
> Acked-by Siobhan Butler <siobhan.a.butler@intel.com>

Applied, thanks