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

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

[Reshma Pattan]

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(-)

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

Re: [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 v2] doc: add pdump library to API doxygen

[Ferruh Yigit]

From: Reshma Pattan <reshma.pattan@intel.com>

Add pdump library to API doxygen.

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---

v2:
* Move pdump higher position in the index
---
 doc/api/doxy-api-index.md | 1 +
 doc/api/doxy-api.conf     | 1 +
 2 files changed, 2 insertions(+)

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6675f96..ed1a204 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 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.9.3

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

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Thursday, December 1, 2016 11:02 AM
> To: dev@dpdk.org
> Cc: Pattan, Reshma <reshma.pattan@intel.com>
> Subject: [dpdk-dev] [PATCH v2] doc: add pdump library to API doxygen
> 
> From: Reshma Pattan <reshma.pattan@intel.com>
> 
> Add pdump library to API doxygen.
> 
> Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

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

[Thomas Monjalon]

2016-12-01 13:28, Mcnamara, John:
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Thursday, December 1, 2016 11:02 AM
> > To: dev@dpdk.org
> > Cc: Pattan, Reshma <reshma.pattan@intel.com>
> > Subject: [dpdk-dev] [PATCH v2] doc: add pdump library to API doxygen
> > 
> > From: Reshma Pattan <reshma.pattan@intel.com>
> > 
> > Add pdump library to API doxygen.
> > 
> > Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

It triggers a doxygen error:
lib/librte_pdump/rte_pdump.h:204: warning: Found unknown command `\type'
lib/librte_pdump/rte_pdump.h:214: warning: The following parameters of
rte_pdump_set_socket_dir(const char *path, enum rte_pdump_socktype type)
are not documented:
   parameter 'type'

Fixed with this change:
- * @type
+ * @param type

Applied, thanks