From patchwork Wed Jun 26 15:20:55 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "A.McLoughlin" X-Patchwork-Id: 55416 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5C2522BEA; Wed, 26 Jun 2019 17:21:20 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id E963D2B82 for ; Wed, 26 Jun 2019 17:21:18 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Jun 2019 08:21:17 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,420,1557212400"; d="scan'208";a="245457688" Received: from silpixa00389822.ir.intel.com (HELO silpixa00389822.ger.corp.intel.com) ([10.237.223.42]) by orsmga001.jf.intel.com with ESMTP; 26 Jun 2019 08:21:14 -0700 From: "A.McLoughlin" To: dev@dpdk.org Cc: marko.kovacevic@intel.com, john.mcnamara@intel.com, ferruh.yigit@intel.com, "A.McLoughlin" Date: Wed, 26 Jun 2019 16:20:55 +0100 Message-Id: <20190626152055.30369-1-aideen.mcloughlin@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH] doc/api: add missing header file to API documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The APIs in the rte_bus_vdev.h file were not part of the API documentation. I added this header file to the doxygen config file with the name vdev. Signed-off-by: A.McLoughlin Acked-by: Ferruh Yigit --- doc/api/doxy-api-index.md | 1 + doc/api/doxy-api.conf.in | 1 + drivers/bus/vdev/rte_bus_vdev.h | 6 ++++++ 3 files changed, 8 insertions(+) diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 715248dd1..1ff31b790 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -31,6 +31,7 @@ The public API headers are grouped by topics: [latency] (@ref rte_latencystats.h), [devargs] (@ref rte_devargs.h), [PCI] (@ref rte_pci.h), + [vdev] (@ref rte_bus_vdev.h), [vfio] (@ref rte_vfio.h) - **device specific**: diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index b9896cb63..1fa064b36 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -4,6 +4,7 @@ PROJECT_NAME = DPDK PROJECT_NUMBER = @VERSION@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ + @TOPDIR@/drivers/bus/vdev \ @TOPDIR@/drivers/crypto/scheduler \ @TOPDIR@/drivers/mempool/dpaa2 \ @TOPDIR@/drivers/net/bnxt \ diff --git a/drivers/bus/vdev/rte_bus_vdev.h b/drivers/bus/vdev/rte_bus_vdev.h index 9ae3eaae3..2bc46530c 100644 --- a/drivers/bus/vdev/rte_bus_vdev.h +++ b/drivers/bus/vdev/rte_bus_vdev.h @@ -5,6 +5,12 @@ #ifndef RTE_VDEV_H #define RTE_VDEV_H +/** + * @file + * RTE virtual bus API + * + */ + #ifdef __cplusplus extern "C" { #endif