From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH] doc: add example programs to doxygen api docs Date: Sun, 13 Dec 2015 23:03:52 +0100 Message-ID: <1763729.9jqLOAaaJI@xps13> References: <1449841311-5372-1-git-send-email-john.mcnamara@intel.com> <1589699.YrWuBkibJg@xps13> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev@dpdk.org To: "Mcnamara, John" Return-path: Received: from mail-wm0-f51.google.com (mail-wm0-f51.google.com [74.125.82.51]) by dpdk.org (Postfix) with ESMTP id 32B3237A6 for ; Sun, 13 Dec 2015 23:05:09 +0100 (CET) Received: by mail-wm0-f51.google.com with SMTP id n186so95166769wmn.1 for ; Sun, 13 Dec 2015 14:05:09 -0800 (PST) In-Reply-To: List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 2015-12-11 14:31, Mcnamara, John: > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] > > 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 > > > > Note sure of the benefit. > > I think it would make more sense if an example was linked from the related > > API, e.g. l3fwd-acl from rte_acl.h. > > Hi, > > That is more or less the way it works. The links are bidirectional header/api <-> example. > > Have a look at the rte_acl.h html output after the patch is applied. Yes, it's nice. Applied with minor changes, thanks