From 42490f387372d3cd86eef1427f9c9d7b60133493 Mon Sep 17 00:00:00 2001 From: Aideen McLoughlin Date: Wed, 26 Jun 2019 16:20:55 +0100 Subject: [PATCH] doc: add vdev doxygen 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: Aideen 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 d0e32b1432..6c2d888ee0 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 b9896cb637..1fa064b365 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 9ae3eaae30..2bc46530c9 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 -- 2.20.1