[dpdk-dev] [PATCH] ethdev: group constant definitions in Doxygen

[Andrew Rybchenko]

On 9/9/21 8:02 PM, Ferruh Yigit wrote:
> On 8/30/2021 11:42 AM, Thomas Monjalon wrote:
>> A lot of flags are parts of a group but are documented alone.
>> The Doxygen syntax @{ and @} for grouping is used
>> to make flags appear together and have a common description.
>>
>> Some Rx/Tx offload flags and RSS definitions are not grouped
>> because they need to be all properly documented first.
>>
>> Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
>> ---
>>  lib/ethdev/rte_ethdev.h | 71 ++++++++++++++++++++++++++++-------------
>>  1 file changed, 48 insertions(+), 23 deletions(-)
>>
>> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
>> index d2b27c351f..0924c9fc68 100644
>> --- a/lib/ethdev/rte_ethdev.h
>> +++ b/lib/ethdev/rte_ethdev.h
>> @@ -276,7 +276,7 @@ struct rte_eth_stats {
>>  	/**< Total number of queue packets received that are dropped. */
>>  };
>>  
>> -/**
>> +/**@{@name Link speed capabilities
>>   * Device supported speeds bitmap flags
>>   */
>>  #define ETH_LINK_SPEED_AUTONEG  (0 <<  0)  /**< Autonegotiate (all speeds) */
>> @@ -296,8 +296,9 @@ struct rte_eth_stats {
>>  #define ETH_LINK_SPEED_56G      (1 << 13)  /**<  56 Gbps */
>>  #define ETH_LINK_SPEED_100G     (1 << 14)  /**< 100 Gbps */
>>  #define ETH_LINK_SPEED_200G     (1 << 15)  /**< 200 Gbps */
>> +/**@}*/
> +1 to use Doxygen grouping, and changes looks good to me.

+1