Message ID | 1430304467-12658-1-git-send-email-john.mcnamara@intel.com (mailing list archive) |
---|---|
State | Accepted, archived |
Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 2A7BDC7FE; Wed, 29 Apr 2015 12:47:52 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id B74EBC7EE for <dev@dpdk.org>; Wed, 29 Apr 2015 12:47:50 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga101.jf.intel.com with ESMTP; 29 Apr 2015 03:47:49 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,670,1422950400"; d="scan'208";a="563581680" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 29 Apr 2015 03:47:48 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t3TAlloW026890; Wed, 29 Apr 2015 11:47:48 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t3TAll7Y012693; Wed, 29 Apr 2015 11:47:47 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t3TAllmF012689; Wed, 29 Apr 2015 11:47:47 +0100 From: John McNamara <john.mcnamara@intel.com> To: dev@dpdk.org Date: Wed, 29 Apr 2015 11:47:47 +0100 Message-Id: <1430304467-12658-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH] doc: disable doxygen member sorting X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK <dev.dpdk.org> List-Unsubscribe: <http://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> |
Commit Message
John McNamara
April 29, 2015, 10:47 a.m. UTC
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(+)
Comments
> -----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. --
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. > -- > > >
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. > -- > > >
> > > 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
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