All of lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: Re: [PATCH] doc: add example programs to doxygen api docs
Date: Fri, 11 Dec 2015 14:44:59 +0100	[thread overview]
Message-ID: <1589699.YrWuBkibJg@xps13> (raw)
In-Reply-To: <1449841311-5372-1-git-send-email-john.mcnamara@intel.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.

  reply	other threads:[~2015-12-11 13:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-12-11 13:41 [PATCH] doc: add example programs to doxygen api docs John McNamara
2015-12-11 13:44 ` Thomas Monjalon [this message]
2015-12-11 14:31   ` Mcnamara, John
2015-12-13 22:03     ` Thomas Monjalon

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=1589699.YrWuBkibJg@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.