From: Reshma Pattan <reshma.pattan@intel.com>
Date: Thu, 1 Dec 2016 11:02:10 +0000 (+0000)
Subject: doc: add pdump library to API doxygen
X-Git-Tag: spdx-start~5296
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=6d059e998091550b570f88e9cf6b81d6a76e8005;p=dpdk.git

doc: add pdump library to API doxygen

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6675f96527..ed1a204ead 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -136,6 +136,7 @@ There are many libraries, so their headers may be grouped by topics:
 
 - **debug**:
   [jobstats]           (@ref rte_jobstats.h),
+  [pdump]              (@ref rte_pdump.h),
   [hexdump]            (@ref rte_hexdump.h),
   [debug]              (@ref rte_debug.h),
   [log]                (@ref rte_log.h),
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index 9dc7ae5c8a..b340fcf2bd 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -51,6 +51,7 @@ INPUT                   = doc/api/doxy-api-index.md \
                           lib/librte_mempool \
                           lib/librte_meter \
                           lib/librte_net \
+                          lib/librte_pdump \
                           lib/librte_pipeline \
                           lib/librte_port \
                           lib/librte_power \
diff --git a/lib/librte_pdump/rte_pdump.h b/lib/librte_pdump/rte_pdump.h
index 924b8043d8..ba6e39b09d 100644
--- a/lib/librte_pdump/rte_pdump.h
+++ b/lib/librte_pdump/rte_pdump.h
@@ -201,7 +201,7 @@ rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
  *
  * @param path
  * directory path for server or client socket.
- * @type
+ * @param type
  * specifies RTE_PDUMP_SOCKET_SERVER if socket path is for server.
  * (or)
  * specifies RTE_PDUMP_SOCKET_CLIENT if socket path is for client.