From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v2] doc: add pdump library to API doxygen
Date: Tue, 06 Dec 2016 15:44:12 +0100
Message-ID: <2333086.mRoocdCpYd@xps13>
References: <1479220879-7914-1-git-send-email-reshma.pattan@intel.com>
 <20161201110210.10601-1-ferruh.yigit@intel.com>
 <B27915DBBA3421428155699D51E4CFE20266C2B8@IRSMSX103.ger.corp.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, "Mcnamara, John" <john.mcnamara@intel.com>, "Yigit,
 Ferruh" <ferruh.yigit@intel.com>
To: "Pattan, Reshma" <reshma.pattan@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wj0-f182.google.com (mail-wj0-f182.google.com
 [209.85.210.182]) by dpdk.org (Postfix) with ESMTP id B436147D1
 for <dev@dpdk.org>; Tue,  6 Dec 2016 15:44:14 +0100 (CET)
Received: by mail-wj0-f182.google.com with SMTP id xy5so323827814wjc.0
 for <dev@dpdk.org>; Tue, 06 Dec 2016 06:44:14 -0800 (PST)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE20266C2B8@IRSMSX103.ger.corp.intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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