From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1F6F2A2E1B for ; Wed, 4 Sep 2019 05:41:18 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1CF961BEA6; Wed, 4 Sep 2019 05:41:17 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by dpdk.org (Postfix) with ESMTP id EFBAA1B203 for ; Wed, 4 Sep 2019 05:41:14 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id x843dt3l001507; Tue, 3 Sep 2019 20:41:13 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=pfpt0818; bh=zmE769l3D9Dc8Fd7kty/BhxS34Xe5KVN6vgzE4apjII=; b=C+wb5VR7PPF4ucU7E6ievqUJxUXn8Jw+0VWOpM3tCa7+TkHb0RnpiGdmER+GZwwoCxdq LAkBrsq9Zo7iHsFj5y3fKhXPSy5BGqYeIqumBX2cPq47QOic8aaWSx7CkEvnslq/94UV 7QRQQwtpG3OUNfMYUWypYhJMEPnDKjGJvfAI5dBzLXf1A7ylf8f0M9/ZZ97v+IVWAoeb 0dqWmoYT1nhNLaogN00qkuVvJrrbhoVQP86p+YknftLOOmZi4PgYlhaWJu5ql0VH4noE 7cuXyE6gAwagTa2zdmR1Y/OoeA/4PXn6yjPKTKfY3eiCFa0gjd+LnnIwLFa4DJJMJgJC Ng== Received: from sc-exch04.marvell.com ([199.233.58.184]) by mx0a-0016f401.pphosted.com with ESMTP id 2uqp8pd2aq-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Tue, 03 Sep 2019 20:41:13 -0700 Received: from SC-EXCH03.marvell.com (10.93.176.83) by SC-EXCH04.marvell.com (10.93.176.84) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Tue, 3 Sep 2019 20:41:11 -0700 Received: from NAM01-SN1-obe.outbound.protection.outlook.com (104.47.32.50) by SC-EXCH03.marvell.com (10.93.176.83) with Microsoft SMTP Server (TLS) id 15.0.1367.3 via Frontend Transport; Tue, 3 Sep 2019 20:41:11 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=dbUgZeeqJGGMPMuQA98OV3Bn+p8tAJF2dUu2XlFfrpxOWs3miHVEFnfNmPnvLhP15PkJ1Sn3+YOWtK6RM/68zgpRhOFK81JzJCdM09J1ZDjr/u7KdKrpzrgJdcVP+8GkwOcxH3zalHgl4VYNNldku6EqMrcoUvESUgaebbEMuReEwGZ1kE6WpIuRvIFZoMEJqshxz3gTEACChQUZHnIzeFaGmIcaZ8KLrCnK10D9yt6l7sci6c5QCMy0SrzGSk1EkM0l2sxJ92ZAP0V7vuoylWBnT3z0OxITMNeRD0wbjQ0k623NFL3X7nAzSS+De/1psPgOrQjDLTHVJ3T6EjZgiw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zmE769l3D9Dc8Fd7kty/BhxS34Xe5KVN6vgzE4apjII=; b=Jjh80zsrRDmRhFKZvZPF2wvr3cs/Spznw/LfetlOECAarXzLsp+OwauogXgmzH8EiQzQ2rSe4vanvjhvY0f72zVTwiBDCAK7JUA97m2+2XruMdSMzSETBY24igiOVWytgcKHWrP7wOr44KYmkf5+C8S3UpCTg5O7evlX0be0oZZKY6BP4O1C/r4Fs/FH8ikBeDzBY6lHSC8LWVDde3wfIDsSpiR85boJqZjKAjdL50pbEtk7vGMSinRqCltjjFXAfuQqWSJferld5F77CvX/e4ZYye4FGMhp9qG8uPGCPHqGbvohCJjmkgSRubyZ0S0R7ylOOsjB7357M7gMi7iSZw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=marvell.com; dmarc=pass action=none header.from=marvell.com; dkim=pass header.d=marvell.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector2-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zmE769l3D9Dc8Fd7kty/BhxS34Xe5KVN6vgzE4apjII=; b=NSisd0Ym2E3xpvAEB6v1ifYBcm35XoXpn5K8Gw4/nfjhrPhxPQemPuMW5bI04eBXoeNSW6Z3fquI9ylRzASLtWXyqDCMeDonWxEIqGhi8FJ9Sm1ZElQBRaqGB357qtIJTMKV6GmJb0WwqIEi+F93n6rPfQeyChc8/uEKbVl6wT0= Received: from MN2PR18MB2877.namprd18.prod.outlook.com (20.179.20.218) by MN2PR18MB2831.namprd18.prod.outlook.com (20.179.21.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2220.20; Wed, 4 Sep 2019 03:41:09 +0000 Received: from MN2PR18MB2877.namprd18.prod.outlook.com ([fe80::7cdd:71d0:6771:4bed]) by MN2PR18MB2877.namprd18.prod.outlook.com ([fe80::7cdd:71d0:6771:4bed%6]) with mapi id 15.20.2220.021; Wed, 4 Sep 2019 03:41:09 +0000 From: Anoob Joseph To: Radu Nicolau , "dev@dpdk.org" , Thomas Monjalon , "akhil.goyal@nxp.com" CC: "konstantin.ananyev@intel.com" , "bernard.iremonger@intel.com" , "declan.doherty@intel.com" , "stephen@networkplumber.org" Thread-Topic: [EXT] [PATCH] security: update doxygen fields Thread-Index: AQHVYlcxS1u6FqFuxEGiJHb203Fg0qca31Ag Date: Wed, 4 Sep 2019 03:41:09 +0000 Message-ID: References: <1567515451-7764-1-git-send-email-radu.nicolau@intel.com> In-Reply-To: <1567515451-7764-1-git-send-email-radu.nicolau@intel.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [115.113.156.2] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 63c7a2f7-611d-42b4-f824-08d730e9b9cf x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(5600166)(711020)(4605104)(1401327)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7193020); SRVR:MN2PR18MB2831; x-ms-traffictypediagnostic: MN2PR18MB2831: x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:8273; x-forefront-prvs: 0150F3F97D x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(346002)(376002)(39860400002)(136003)(366004)(396003)(199004)(189003)(13464003)(4326008)(9686003)(15650500001)(3846002)(6116002)(186003)(6506007)(53546011)(26005)(2501003)(55016002)(6436002)(74316002)(25786009)(55236004)(102836004)(86362001)(5660300002)(6246003)(14454004)(53936002)(8936002)(66066001)(2906002)(8676002)(7736002)(486006)(11346002)(446003)(81166006)(81156014)(476003)(33656002)(52536014)(478600001)(99286004)(305945005)(256004)(14444005)(110136005)(71190400001)(71200400001)(7696005)(76176011)(316002)(76116006)(66946007)(66476007)(64756008)(66556008)(66446008)(229853002)(54906003); DIR:OUT; SFP:1101; SCL:1; SRVR:MN2PR18MB2831; H:MN2PR18MB2877.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: marvell.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: zp+OzDxdpnTl5E7xr2ECVh7Ytsde2+dKpYfqjztI4GaWPqhKsX7P40NyN0h5Hcwi/bnXrIeFpWtCRe3Hm9auBGG6UbcClF5rlfgNSxeodGcCgvsczeZN5mE2xfRnDLZVqFrdVJL0Fq45g8fkxwnQe3+eMTn8KebRzO+SZSIpA4972TtY/75R6Wugp4UC7/7TM77szpUL/8sD9+MnFcNGlEMeoGLaS17wMQPpxrDdGsOiiEOG9HDLvMH440jyP7jpddnZheTVlBPoBde8d11ZzHnBELpQZIRC5+ken0uBvTSfn/tXLrLN5V42gUMy7J3KHuz9YNULd1Je95UeL0YFkl8uRNlDebX/9L5Yi39W5yRGBnWwB7Giz8MgeQEHKmZKHDl4B8otTkTWFyljfNxPpoI+X86ScrDPNYjDdNe0nrk= x-ms-exchange-transport-forked: True Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 63c7a2f7-611d-42b4-f824-08d730e9b9cf X-MS-Exchange-CrossTenant-originalarrivaltime: 04 Sep 2019 03:41:09.7523 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: yuz+WnNwvi5FRWLHbbjbG8hMwL7296UNaL6+Syw2VeCImIVqXEUMtHdbjN8ywNN1bi/QPg1JnrAina+YXU2HVg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR18MB2831 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.70,1.0.8 definitions=2019-09-03_05:2019-09-03,2019-09-03 signatures=0 Subject: Re: [dpdk-dev] [EXT] [PATCH] security: update doxygen fields X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Hi Radu, Most parts of the file(rte_security.h) follows 'description after item' met= hodology. Do you think we should stick to that? @Akhil, @Thomas, what is the recommended way of documenting individual memb= ers of structure? Is it 'description after the item' or 'description before= the item'? Thanks, Anoob > -----Original Message----- > From: Radu Nicolau > 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 ; > Radu Nicolau > Subject: [EXT] [PATCH] security: update doxygen fields >=20 > External Email >=20 > ---------------------------------------------------------------------- > Replace /**< with /** for multiline doxygen comments. >=20 > Signed-off-by: Radu Nicolau > --- > lib/librte_security/rte_security.h | 14 +++++++------- > 1 file changed, 7 insertions(+), 7 deletions(-) >=20 > 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; >=20 > - /**< 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; >=20 > - /**< 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; >=20 > - /**< 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; >=20 > - /**< 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; >=20 > - /**< 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; >=20 > - /**< 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