DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>, dev@dpdk.org
Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com
Subject: Re: [dpdk-dev] [PATCH] doc: show internal functions in doxygen
Date: Thu, 18 Oct 2018 17:22:58 +0100	[thread overview]
Message-ID: <2eaff214-a50f-b018-80a0-5074f8fa1607@intel.com> (raw)
In-Reply-To: <20181018160858.23114-1-thomas@monjalon.net>

On 10/18/2018 5:08 PM, Thomas Monjalon wrote:
> Not sure we want to show the internal functions to users.
> It may be useful only for PMD developers.
> Do we vote? +1 / -1 welcome!

What is affected from this setting, can you give an example what was not shown
will be shown now?

> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/api/doxy-api.conf.in | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
> index 3b652ac9c..85834c9e7 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -71,6 +71,7 @@ MACRO_EXPANSION         = YES
>  EXPAND_ONLY_PREDEF      = YES
>  EXTRACT_STATIC          = YES
>  DISTRIBUTE_GROUP_DOC    = YES
> +INTERNAL_DOCS           = YES
>  HIDE_UNDOC_MEMBERS      = YES
>  HIDE_UNDOC_CLASSES      = YES
>  HIDE_SCOPE_NAMES        = YES
> 

  reply	other threads:[~2018-10-18 16:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-18 16:08 Thomas Monjalon
2018-10-18 16:22 ` Ferruh Yigit [this message]
2018-10-18 17:04   ` Thomas Monjalon
2018-10-19  7:39     ` Ferruh Yigit
2018-10-22  6:15       ` Shreyansh Jain

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=2eaff214-a50f-b018-80a0-5074f8fa1607@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=thomas@monjalon.net \
    /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).