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

Ferruh Yigit ferruh.yigit at intel.com
Fri Oct 19 09:39:04 CEST 2018


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


More information about the dev mailing list