From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: Re: [PATCH] doc: show internal functions in doxygen Date: Fri, 19 Oct 2018 08:39:04 +0100 Message-ID: <11352cd2-eff3-ba30-23c6-47bd8d100f66@intel.com> References: <20181018160858.23114-1-thomas@monjalon.net> <2eaff214-a50f-b018-80a0-5074f8fa1607@intel.com> <2940983.jWfRA7H8VK@xps> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Cc: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com To: Thomas Monjalon Return-path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 193E75F38 for ; Fri, 19 Oct 2018 09:39:07 +0200 (CEST) In-Reply-To: <2940983.jWfRA7H8VK@xps> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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