From: "A.McLoughlin" <aideen.mcloughlin@intel.com>
To: dev@dpdk.org
Cc: marko.kovacevic@intel.com, john.mcnamara@intel.com,
ferruh.yigit@intel.com,
"A.McLoughlin" <aideen.mcloughlin@intel.com>
Subject: [dpdk-dev] [PATCH] doc/api: add missing header file to API documentation
Date: Wed, 26 Jun 2019 16:20:55 +0100 [thread overview]
Message-ID: <20190626152055.30369-1-aideen.mcloughlin@intel.com> (raw)
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(+)
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
--
2.17.1
--------------------------------------------------------------
Intel Research and Development Ireland Limited
Registered in Ireland
Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
Registered Number: 308263
This e-mail and any attachments may contain confidential material for the sole
use of the intended recipient(s). Any review or distribution by others is
strictly prohibited. If you are not the intended recipient, please contact the
sender and delete all copies.
next reply other threads:[~2019-06-26 15:21 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-26 15:20 A.McLoughlin [this message]
2019-06-26 16:32 ` Ferruh Yigit
2019-07-08 19:52 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190626152055.30369-1-aideen.mcloughlin@intel.com \
--to=aideen.mcloughlin@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).