[dpdk-dev] [PATCH] doc: show internal functions in doxygen

Ferruh Yigit ferruh.yigit at intel.com
Thu Oct 18 18:22:58 CEST 2018


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 at 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
> 



More information about the dev mailing list