Re: [PATCH v3 6/7] app/procinfo: fix some wrong doxygen syntax

[Dongdong Liu <liudongdong3@huawei.com>]

On 2022/9/23 15:53, Pattan, Reshma wrote:
>
>
>> -----Original Message-----
>> From: Dongdong Liu <liudongdong3@huawei.com>
>> Sent: Wednesday, September 21, 2022 3:27 PM
>> To: dev@dpdk.org; Pattan, Reshma <reshma.pattan@intel.com>;
>> thomas@monjalon.net; ferruh.yigit@xilinx.com;
>> andrew.rybchenko@oktetlabs.ru
>> Cc: Dongdong Liu <liudongdong3@huawei.com>; Maryam Tahhan
>> <maryam.tahhan@intel.com>
>> 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
> .
>