From: Hemant Agrawal <hemant.agrawal@nxp.com>
Date: Thu, 12 Apr 2018 06:23:36 +0000 (+0530)
Subject: doc: add VFIO API in doxygen
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=c94eb6db0adba3f71fa469dbacffe6fca93a354d;p=dpdk.git

doc: add VFIO API in doxygen

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 2f04619cb6..d5ccbe8a19 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -52,7 +52,8 @@ The public API headers are grouped by topics:
   [bitrate]            (@ref rte_bitrate.h),
   [latency]            (@ref rte_latencystats.h),
   [devargs]            (@ref rte_devargs.h),
-  [PCI]                (@ref rte_pci.h)
+  [PCI]                (@ref rte_pci.h),
+  [vfio]               (@ref rte_vfio.h)
 
 - **device specific**:
   [softnic]            (@ref rte_eth_softnic.h),
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index cda52fdfbe..ad8bdcf616 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -82,6 +82,7 @@ INPUT                   = doc/api/doxy-api-index.md \
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
 PREDEFINED              = __DOXYGEN__ \
+			   VFIO_PRESENT \
                           __attribute__(x)=
 
 OPTIMIZE_OUTPUT_FOR_C   = YES
diff --git a/lib/librte_eal/common/include/rte_vfio.h b/lib/librte_eal/common/include/rte_vfio.h
index d26ab01cbf..f363cac6a9 100644
--- a/lib/librte_eal/common/include/rte_vfio.h
+++ b/lib/librte_eal/common/include/rte_vfio.h
@@ -5,6 +5,11 @@
 #ifndef _RTE_VFIO_H_
 #define _RTE_VFIO_H_
 
+/**
+ * @file
+ * RTE VFIO. This library provides various VFIO related utility functions.
+ */
+
 /*
  * determine if VFIO is present on the system
  */