[dpdk-dev,v2] doc: add pdump library to API doxygen
Checks
Commit Message
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(+)
Comments
> -----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>
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
@@ -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),
@@ -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 \