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

Shreyansh Jain shreyansh.jain at nxp.com
Mon Oct 22 08:15:44 CEST 2018


On Friday 19 October 2018 01:09 PM, Ferruh Yigit wrote:
> On 10/18/2018 6:04 PM, Thomas Monjalon wrote:
>> 18/10/2018 18:22, Ferruh Yigit:
>>> 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?
>>
>> For instance, most of the things in rte_ethdev_core.h.
>> All the doxygen with @internal tag are affected.
> 
> rte_ethdev_core.h is not part of API documentation but I randomly checked
> rte_lpm.h which has some @internal structures.
> 
> But those in the lpm header is the ones for ABI versioning, I think it is
> confusing to expose them to the user, and documentation doesn't highlight that
> it is internal.
> 
> So not a strong opinion, but from my side -1
> 

-1 from me as well.

Even I think it would be overload of information in Doxygen. And to add, 
some places might require re-documenting to cleanup internal markers.
My opinion: direct code would help better than doxygen for these cases.


More information about the dev mailing list