diff mbox

[dpdk-dev] doc: add pdump library to API doxygen

Message ID 1479220879-7914-1-git-send-email-reshma.pattan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

Pattan, Reshma Nov. 15, 2016, 2:41 p.m. UTC 
Add pdump library to API doxygen.

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---
 doc/api/doxy-api-index.md | 3 ++-
 doc/api/doxy-api.conf     | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

Comments

Thomas Monjalon Nov. 15, 2016, 4:36 p.m. UTC | #1 
2016-11-15 14:41, Reshma Pattan:
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -140,7 +140,8 @@ There are many libraries, so their headers may be grouped by topics:
>    [debug]              (@ref rte_debug.h),
>    [log]                (@ref rte_log.h),
>    [warnings]           (@ref rte_warnings.h),
> -  [errno]              (@ref rte_errno.h)
> +  [errno]              (@ref rte_errno.h),
> +  [pdump]              (@ref rte_pdump.h)

The end of this list are trivial headers, what pdump is not.
I think it should be at the top of the list, between jobstats and hexdump.
diff mbox

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6675f96..492a0af 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -140,7 +140,8 @@  There are many libraries, so their headers may be grouped by topics:
   [debug]              (@ref rte_debug.h),
   [log]                (@ref rte_log.h),
   [warnings]           (@ref rte_warnings.h),
-  [errno]              (@ref rte_errno.h)
+  [errno]              (@ref rte_errno.h),
+  [pdump]              (@ref rte_pdump.h)
 
 - **misc**:
   [EAL config]         (@ref rte_eal.h),
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index 9dc7ae5..b340fcf 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 \