[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 at dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Thursday, December 1, 2016 11:02 AM
> > To: dev at dpdk.org
> > Cc: Pattan, Reshma <reshma.pattan at intel.com>
> > Subject: [dpdk-dev] [PATCH v2] doc: add pdump library to API doxygen
> > 
> > From: Reshma Pattan <reshma.pattan at intel.com>
> > 
> > Add pdump library to API doxygen.
> > 
> > Signed-off-by: Reshma Pattan <reshma.pattan at intel.com>
> 
> Acked-by: John McNamara <john.mcnamara at 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