From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] doc: add example programs to doxygen api docs
Date: Sun, 13 Dec 2015 23:03:52 +0100 [thread overview]
Message-ID: <1763729.9jqLOAaaJI@xps13> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE202403413@IRSMSX103.ger.corp.intel.com>
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 <john.mcnamara@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.
Yes, it's nice.
Applied with minor changes, thanks
prev parent reply other threads:[~2015-12-13 22:05 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-11 13:41 John McNamara
2015-12-11 13:44 ` Thomas Monjalon
2015-12-11 14:31 ` Mcnamara, John
2015-12-13 22:03 ` Thomas Monjalon [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1763729.9jqLOAaaJI@xps13 \
--to=thomas.monjalon@6wind.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).