From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
Thomas Monjalon <thomas@monjalon.net>,
dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] ethdev: group constant definitions in Doxygen
Date: Fri, 10 Sep 2021 11:07:12 +0300 [thread overview]
Message-ID: <dc9e68c8-5881-631a-6298-6d88c67790ef@oktetlabs.ru> (raw)
In-Reply-To: <45c1e73c-bb60-c5a4-c4f0-7971b4066c03@intel.com>
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@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
next prev parent reply other threads:[~2021-09-10 8:07 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-30 10:42 Thomas Monjalon
2021-09-09 17:02 ` Ferruh Yigit
2021-09-10 8:07 ` Andrew Rybchenko [this message]
2021-09-23 16:35 ` Kevin Traynor
2021-09-27 11:52 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dc9e68c8-5881-631a-6298-6d88c67790ef@oktetlabs.ru \
--to=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).