[dpdk-dev] [PATCH] doc: add example programs to doxygen api docs

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> Sent: Friday, December 11, 2015 1:45 PM
> To: Mcnamara, John
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: add example programs to doxygen api
> docs
> 
> 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 <john.mcnamara at intel.com>
> 
> 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.

John.
--