From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 28FFCA0542; Sat, 24 Sep 2022 10:13:02 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C2982400D5; Sat, 24 Sep 2022 10:13:01 +0200 (CEST) Received: from szxga08-in.huawei.com (szxga08-in.huawei.com [45.249.212.255]) by mails.dpdk.org (Postfix) with ESMTP id 6E3DE400D4 for ; Sat, 24 Sep 2022 10:13:00 +0200 (CEST) Received: from kwepemi500017.china.huawei.com (unknown [172.30.72.53]) by szxga08-in.huawei.com (SkyGuard) with ESMTP id 4MZM9C2sSjz1P6mK; Sat, 24 Sep 2022 16:08:47 +0800 (CST) Received: from [10.67.103.235] (10.67.103.235) by kwepemi500017.china.huawei.com (7.221.188.110) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.31; Sat, 24 Sep 2022 16:12:57 +0800 Subject: Re: [PATCH v3 6/7] app/procinfo: fix some wrong doxygen syntax To: "Pattan, Reshma" , "dev@dpdk.org" , "thomas@monjalon.net" , "ferruh.yigit@xilinx.com" , "andrew.rybchenko@oktetlabs.ru" References: <20220722091236.15469-1-liudongdong3@huawei.com> <20220921142655.16427-1-liudongdong3@huawei.com> <20220921142655.16427-7-liudongdong3@huawei.com> CC: Maryam Tahhan From: Dongdong Liu Message-ID: Date: Sat, 24 Sep 2022 16:12:57 +0800 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:45.0) Gecko/20100101 Thunderbird/45.7.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset="windows-1252"; format=flowed Content-Transfer-Encoding: 7bit X-Originating-IP: [10.67.103.235] X-ClientProxiedBy: dggems706-chm.china.huawei.com (10.3.19.183) To kwepemi500017.china.huawei.com (7.221.188.110) X-CFilter-Loop: Reflected X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 2022/9/23 15:53, Pattan, Reshma wrote: > > >> -----Original Message----- >> From: Dongdong Liu >> Sent: Wednesday, September 21, 2022 3:27 PM >> To: dev@dpdk.org; Pattan, Reshma ; >> thomas@monjalon.net; ferruh.yigit@xilinx.com; >> andrew.rybchenko@oktetlabs.ru >> Cc: Dongdong Liu ; Maryam Tahhan >> >> Subject: [PATCH v3 6/7] app/procinfo: fix some wrong doxygen syntax > >> -/**< mask of enabled ports */ >> +/* mask of enabled ports */ >> static unsigned long enabled_port_mask; > > Ok you are using the prefix comments, so as per documentation . the comment should look like below. So you can consider using this style in the rest of the places. > /** Mask of enabled ports. */ > https://doc.dpdk.org/guides/contributing/documentation.html 5.6. Doxygen Guidelines The DPDK API is documented using Doxygen comment annotations in the header files It seems the DPDK API need to use doxygen syntax. The procinfo code maybe not need to use doxygen syntax. Thanks, Dongdong > > > > Thanks, > Reshma > . >