doc: add pdump library to API doxygen
authorReshma Pattan <reshma.pattan@intel.com>
Thu, 1 Dec 2016 11:02:10 +0000 (11:02 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 6 Dec 2016 14:43:13 +0000 (15:43 +0100)
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/api/doxy-api-index.md
doc/api/doxy-api.conf
lib/librte_pdump/rte_pdump.h

index 6675f96..ed1a204 100644 (file)
@@ -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),
index 9dc7ae5..b340fcf 100644 (file)
@@ -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 \
index 924b804..ba6e39b 100644 (file)
@@ -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.