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

[Thomas Monjalon]

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.

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

[Reshma Pattan]

Add pdump library to API doxygen.

Signed-off-by: Reshma Pattan 
---
 doc/api/doxy-api-index.md | 3 ++-
 doc/api/doxy-api.conf | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

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 \
-- 
2.7.4