From patchwork Sun Jul 19 10:52:17 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 6499 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 1FAC0C354; Sun, 19 Jul 2015 12:53:42 +0200 (CEST) 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) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=8mky2jBM+PLhUTYyrmbBZYd+JOMs5alvtKcXtMdyT9Q=; b=ZVSM38MsOgQAm0jHi0pUJPhgJLPRLQNeWZpbPiYiqxhxiOQw3npeTdy7hDMUZxRRKU qx5DG25uuBcvWeZMQk3PLEyc2/uCBg3n2DkrGg6nsvNIaNiV7nBYyGKwgLRngVLEkJBH 3GYE+DgCeS9mvnjFu2z52TIFrGkBLC5WdajmAE/veCMq5LljaUdg5NnuSH6osF9YRtkb UwSVBZn76jClF2AesKwKcNyqVmqcaHU/fkBIie2ecUgUSBv/QeXITmVcBtQzjaOks9Cu IB+/IeQCIj2eMX8Nq5XsrIV178LIeEIcUKB281XpKam9PjqEpy7akUmBWnoxVlPcYKqQ mJUQ== X-Gm-Message-State: ALoCoQlzo8q0Bw1IdtuZVLQ76iJ2qRnDh12a21EGayrxSSqjqfXEog7+yRGSoPkZ+QOABPMu428u X-Received: by 10.180.76.193 with SMTP id m1mr11660533wiw.11.1437303216754; Sun, 19 Jul 2015 03:53:36 -0700 (PDT) Received: from XPS13.localdomain (117.114.118.80.rev.sfr.net. [80.118.114.117]) by smtp.gmail.com with ESMTPSA id d5sm6481160wiz.24.2015.07.19.03.53.34 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 19 Jul 2015 03:53:36 -0700 (PDT) From: Thomas Monjalon To: dev@dpdk.org Date: Sun, 19 Jul 2015 12:52:17 +0200 Message-Id: <1437303137-29430-5-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.4.2 In-Reply-To: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> References: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> Subject: [dpdk-dev] [PATCH 4/4] ethdev: fix doxygen internal comments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list 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