vhost: add in doc

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

diff --git a/doc/doxy-api-index.md b/doc/doxy-api-index.md
index f9593a0..6958f8f 100644 (file)
--- a/doc/doxy-api-index.md
+++ b/doc/doxy-api-index.md
@@ -39,6 +39,7 @@ There are many libraries, so their headers may be grouped by topics:
   [ethdev]             (@ref rte_ethdev.h),
   [devargs]            (@ref rte_devargs.h),
   [bond]               (@ref rte_eth_bond.h),
+  [vhost]              (@ref rte_virtio_net.h),
   [KNI]                (@ref rte_kni.h),
   [PCI]                (@ref rte_pci.h),
   [PCI IDs]            (@ref rte_pci_dev_ids.h)

diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index 124fc68..d3d2269 100644 (file)
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -51,7 +51,8 @@ INPUT                   = doc/doxy-api-index.md \
                           lib/librte_ring \
                           lib/librte_sched \
                           lib/librte_table \
-                          lib/librte_timer
+                          lib/librte_timer \
+                          lib/librte_vhost
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
 PREDEFINED              = __DOXYGEN__ \

diff --git a/lib/librte_vhost/rte_virtio_net.h b/lib/librte_vhost/rte_virtio_net.h
index 0412e94..b6548a1 100644 (file)
--- a/lib/librte_vhost/rte_virtio_net.h
+++ b/lib/librte_vhost/rte_virtio_net.h
@@ -34,6 +34,11 @@
 #ifndef _VIRTIO_NET_H_
 #define _VIRTIO_NET_H_
 
+/**
+ * @file
+ * Interface to vhost net
+ */
+
 #include <stdint.h>
 #include <linux/virtio_ring.h>
 #include <linux/virtio_net.h>