From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id BF0F28E7B for ; Fri, 11 Dec 2015 15:31:21 +0100 (CET) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 11 Dec 2015 06:31:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,414,1444719600"; d="scan'208";a="869588970" Received: from irsmsx109.ger.corp.intel.com ([163.33.3.23]) by orsmga002.jf.intel.com with ESMTP; 11 Dec 2015 06:31:20 -0800 Received: from irsmsx111.ger.corp.intel.com (10.108.20.4) by IRSMSX109.ger.corp.intel.com (163.33.3.23) with Microsoft SMTP Server (TLS) id 14.3.248.2; Fri, 11 Dec 2015 14:31:05 +0000 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.13]) by irsmsx111.ger.corp.intel.com ([169.254.2.223]) with mapi id 14.03.0248.002; Fri, 11 Dec 2015 14:31:05 +0000 From: "Mcnamara, John" To: Thomas Monjalon Thread-Topic: [dpdk-dev] [PATCH] doc: add example programs to doxygen api docs Thread-Index: AQHRNBm3KbmZpb/NP02lYV9GE7Ch657FzA2AgAAMN+A= Date: Fri, 11 Dec 2015 14:31:03 +0000 Message-ID: References: <1449841311-5372-1-git-send-email-john.mcnamara@intel.com> <1589699.YrWuBkibJg@xps13> In-Reply-To: <1589699.YrWuBkibJg@xps13> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: "dev@dpdk.org" Subject: Re: [dpdk-dev] [PATCH] doc: add example programs to doxygen api docs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 11 Dec 2015 14:31:22 -0000 > -----Original Message----- > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] > Sent: Friday, December 11, 2015 1:45 PM > To: Mcnamara, John > Cc: dev@dpdk.org > Subject: Re: [dpdk-dev] [PATCH] doc: add example programs to doxygen api > docs >=20 > 2015-12-11 13:41, John McNamara: > > Enable Doxygen parsing of DPDK example files so that the example code > > is linked to and from the API docs. This allows the reader to see > > examples of API usage in context by following a link. > > > > Signed-off-by: John McNamara >=20 > Note sure of the benefit. > I think it would make more sense if an example was linked from the relate= d > API, e.g. l3fwd-acl from rte_acl.h. Hi, That is more or less the way it works. The links are bidirectional header/a= pi <-> example. Have a look at the rte_acl.h html output after the patch is applied. John. --=20