From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: [PATCH 4/4] ethdev: fix doxygen internal comments Date: Sun, 19 Jul 2015 12:52:17 +0200 Message-ID: <1437303137-29430-5-git-send-email-thomas.monjalon@6wind.com> References: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> To: dev@dpdk.org Return-path: Received: from mail-wi0-f173.google.com (mail-wi0-f173.google.com [209.85.212.173]) by dpdk.org (Postfix) with ESMTP id CF278C332 for ; Sun, 19 Jul 2015 12:53:36 +0200 (CEST) Received: by wibud3 with SMTP id ud3so67780026wib.1 for ; Sun, 19 Jul 2015 03:53:36 -0700 (PDT) In-Reply-To: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The internal functions must be marked with the doxygen command @internal. The allocate and release_port functions are not restricted only to dummy drivers. Signed-off-by: Thomas Monjalon --- lib/librte_ether/rte_ethdev.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 8f1cf8d..8b04edc 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -1646,8 +1646,9 @@ extern struct rte_eth_dev rte_eth_devices[]; extern uint8_t rte_eth_dev_count(void); /** - * Function for internal use by port hotplug functions. + * @internal * Returns a ethdev slot specified by the unique identifier name. + * * @param name * The pointer to the Unique identifier name for each Ethernet device * @return @@ -1656,8 +1657,7 @@ extern uint8_t rte_eth_dev_count(void); extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name); /** - * Function for internal use by dummy drivers primarily, e.g. ring-based - * driver. + * @internal * Allocates a new ethdev slot for an ethernet device and returns the pointer * to that slot for the driver to use. * @@ -1670,8 +1670,7 @@ struct rte_eth_dev *rte_eth_dev_allocate(const char *name, enum rte_eth_dev_type type); /** - * Function for internal use by dummy drivers primarily, e.g. ring-based - * driver. + * @internal * Release the specified ethdev port. * * @param eth_dev -- 2.4.2