diff mbox series

doc/api: add missing header file to API documentation

Message ID 20190626152055.30369-1-aideen.mcloughlin@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc/api: add missing header file to API documentation | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/Intel-compilation fail Compilation issues

Commit Message

A.McLoughlin June 26, 2019, 3:20 p.m. UTC
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 <aideen.mcloughlin@intel.com>
---
 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(+)

Comments

Ferruh Yigit June 26, 2019, 4:32 p.m. UTC | #1
On 6/26/2019 4:20 PM, A.McLoughlin wrote:
> 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 <aideen.mcloughlin@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon July 8, 2019, 7:52 p.m. UTC | #2
26/06/2019 18:32, Ferruh Yigit:
> On 6/26/2019 4:20 PM, A.McLoughlin wrote:
> > 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 <aideen.mcloughlin@intel.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

I suspect there are more to add to doxygen.

Applied, thanks
diff mbox series

Patch

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