From: Anoob Joseph <anoobj@marvell.com>
To: Radu Nicolau <radu.nicolau@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>,
Thomas Monjalon <thomas@monjalon.net>,
"akhil.goyal@nxp.com" <akhil.goyal@nxp.com>
Cc: "konstantin.ananyev@intel.com" <konstantin.ananyev@intel.com>,
"bernard.iremonger@intel.com" <bernard.iremonger@intel.com>,
"declan.doherty@intel.com" <declan.doherty@intel.com>,
"stephen@networkplumber.org" <stephen@networkplumber.org>
Subject: Re: [dpdk-dev] [EXT] [PATCH] security: update doxygen fields
Date: Wed, 4 Sep 2019 03:41:09 +0000 [thread overview]
Message-ID: <MN2PR18MB287767C0B84670901EBBD1B9DFB80@MN2PR18MB2877.namprd18.prod.outlook.com> (raw)
In-Reply-To: <1567515451-7764-1-git-send-email-radu.nicolau@intel.com>
Hi Radu,
Most parts of the file(rte_security.h) follows 'description after item' methodology. Do you think we should stick to that?
@Akhil, @Thomas, what is the recommended way of documenting individual members of structure? Is it 'description after the item' or 'description before the item'?
Thanks,
Anoob
> -----Original Message-----
> From: Radu Nicolau <radu.nicolau@intel.com>
> Sent: Tuesday, September 3, 2019 6:28 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; konstantin.ananyev@intel.com;
> bernard.iremonger@intel.com; declan.doherty@intel.com;
> stephen@networkplumber.org; Anoob Joseph <anoobj@marvell.com>;
> Radu Nicolau <radu.nicolau@intel.com>
> Subject: [EXT] [PATCH] security: update doxygen fields
>
> External Email
>
> ----------------------------------------------------------------------
> Replace /**< with /** for multiline doxygen comments.
>
> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
> ---
> lib/librte_security/rte_security.h | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/lib/librte_security/rte_security.h
> b/lib/librte_security/rte_security.h
> index 96806e3..d56907d 100644
> --- a/lib/librte_security/rte_security.h
> +++ b/lib/librte_security/rte_security.h
> @@ -115,14 +115,14 @@ struct rte_security_ipsec_tunnel_param {
> * IPsec Security Association option flags
> */
> struct rte_security_ipsec_sa_options {
> - /**< Extended Sequence Numbers (ESN)
> + /** Extended Sequence Numbers (ESN)
> *
> * * 1: Use extended (64 bit) sequence numbers
> * * 0: Use normal sequence numbers
> */
> uint32_t esn : 1;
>
> - /**< UDP encapsulation
> + /** UDP encapsulation
> *
> * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
> * traverse through NAT boxes.
> @@ -130,7 +130,7 @@ struct rte_security_ipsec_sa_options {
> */
> uint32_t udp_encap : 1;
>
> - /**< Copy DSCP bits
> + /** Copy DSCP bits
> *
> * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
> * the outer IP header in encapsulation, and vice versa in
> @@ -139,7 +139,7 @@ struct rte_security_ipsec_sa_options {
> */
> uint32_t copy_dscp : 1;
>
> - /**< Copy IPv6 Flow Label
> + /** Copy IPv6 Flow Label
> *
> * * 1: Copy IPv6 flow label from inner IPv6 header to the
> * outer IPv6 header.
> @@ -147,7 +147,7 @@ struct rte_security_ipsec_sa_options {
> */
> uint32_t copy_flabel : 1;
>
> - /**< Copy IPv4 Don't Fragment bit
> + /** Copy IPv4 Don't Fragment bit
> *
> * * 1: Copy the DF bit from the inner IPv4 header to the outer
> * IPv4 header.
> @@ -155,7 +155,7 @@ struct rte_security_ipsec_sa_options {
> */
> uint32_t copy_df : 1;
>
> - /**< Decrement inner packet Time To Live (TTL) field
> + /** Decrement inner packet Time To Live (TTL) field
> *
> * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
> * IPv6 Hop Limit after tunnel decapsulation, or before tunnel
> @@ -164,7 +164,7 @@ struct rte_security_ipsec_sa_options {
> */
> uint32_t dec_ttl : 1;
>
> - /**< Explicit Congestion Notification (ECN)
> + /** Explicit Congestion Notification (ECN)
> *
> * * 1: In tunnel mode, enable outer header ECN Field copied from
> * inner header in tunnel encapsulation, or inner header ECN
> --
> 2.7.4
next prev parent reply other threads:[~2019-09-04 3:41 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-03 12:57 [dpdk-dev] " Radu Nicolau
2019-09-04 3:41 ` Anoob Joseph [this message]
2019-09-04 7:46 ` [dpdk-dev] [EXT] " Thomas Monjalon
2019-09-04 9:27 ` Akhil Goyal
2019-09-04 9:18 ` [dpdk-dev] " Akhil Goyal
2019-09-04 9:27 ` [dpdk-dev] [EXT] " Anoob Joseph
2019-09-04 11:03 ` [dpdk-dev] [PATCH v2] " Radu Nicolau
2019-09-19 15:10 ` Akhil Goyal
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=MN2PR18MB287767C0B84670901EBBD1B9DFB80@MN2PR18MB2877.namprd18.prod.outlook.com \
--to=anoobj@marvell.com \
--cc=akhil.goyal@nxp.com \
--cc=bernard.iremonger@intel.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=konstantin.ananyev@intel.com \
--cc=radu.nicolau@intel.com \
--cc=stephen@networkplumber.org \
--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).