From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id F1EB0A054A;
Tue, 25 Oct 2022 15:22:53 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id AAA0B42847;
Tue, 25 Oct 2022 15:22:53 +0200 (CEST)
Received: from NAM12-BN8-obe.outbound.protection.outlook.com
(mail-bn8nam12on2065.outbound.protection.outlook.com [40.107.237.65])
by mails.dpdk.org (Postfix) with ESMTP id C7E35427FF
for <dev@dpdk.org>; Tue, 25 Oct 2022 15:22:52 +0200 (CEST)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
b=moA19S7IlWUr/QLGX2IZYI5NGD9TUQZs0+nfJ/oRkQ9CswvVQy8gcB2c+8E0bhQ8LK9VhY9XRMy0+KxI+ilG+Z1X4EgrVmSqJPaUp5O/N9x3uPjJZMttMh/Iuk4CA03H82mKFV4Z+Seur0bGekMs/6dIxQ72+VCzG8ctl8at1lW44cXFaLY1ctE9s732SQBMebiM74jvDNBWgukB6FviMwv7jI19dTxrSR2E8S6iW3N/idU7OjsXEaFEzDNtpXKKLOuhqiywQ8eVGa+JpW7Txd9ZJuGjJlZqTPz2HmvLZyYbQNM494oDn+SqdPD5BAAwwK8QgiNFkgnzZ/QTrmDklw==
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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
bh=JfeuK2uzCiDPbLL5o89a3JL1A2h4W5S5M1ZdZrwyIXA=;
b=ThkMbw32lXREYc1gYIEP/pQiwQxfYi+XnCXnQ7+rec5pCWgcNG5ZWtilkllvuFcJPntjd3MtzEH5qrCP72PO1onUxDVi+wtF2QseKMvuanSkrxc6j9Eic1dRjYtjNozIG5sz9z+waSI9NOgXETF9zr7nXwSqfguxkdQEI7laExk+Hld6wPmUphr3zwqPEtL5GjhoKSwLQmcZ2cagvKeIVahkwa/PdDAolzSo0uoaXKoz91Yqp+X7mTiXhUywYYXwJ1PDBzx95DnzAannjnALuxiijb0+Sk+Vywn3xWC1ybfNqIzGRL5Mmu+A9Iv8sna6Znwsp+BN0ZO6CI5JvuAwug==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is
216.228.117.160) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com;
dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com;
dkim=none (message not signed); arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com;
s=selector2;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
bh=JfeuK2uzCiDPbLL5o89a3JL1A2h4W5S5M1ZdZrwyIXA=;
b=fd0RHqfiqX8WOt9CNhxjI9k7LTCLpBrWspZDyoqa2HQnWaeEx0vi0D8W2Q+kNQghes7ss7z/RatDgwYN4AuV2BGG2BBKOV6Nz3z328l15bBWcuU+oPH6hoOiC4TqFPj4ACfcFmRDAMlogIOtY2wtx0xyXAb1ze4vW91OpjvLki7KvcYgTicvKmDwVDcaxAYh6V5cO558S4W/pAZ5S07f4jKXGP5Qp/vllOcEUTmSUYMhpuPUzlOcLWkwMCTJUNGm1L+LvJVO5rEr86GrdumI49vOiYvqugQH0aYxQ0Xhj9fXwH6B8DpT34pqClN5/S1aQM0P9nqDQGFNx/yjvGbGxg==
Received: from DM6PR14CA0060.namprd14.prod.outlook.com (2603:10b6:5:18f::37)
by BN9PR12MB5355.namprd12.prod.outlook.com (2603:10b6:408:104::22) with
Microsoft SMTP Server (version=TLS1_2,
cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5723.34; Tue, 25 Oct
2022 13:22:51 +0000
Received: from DM6NAM11FT081.eop-nam11.prod.protection.outlook.com
(2603:10b6:5:18f:cafe::79) by DM6PR14CA0060.outlook.office365.com
(2603:10b6:5:18f::37) with Microsoft SMTP Server (version=TLS1_2,
cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5746.28 via Frontend
Transport; Tue, 25 Oct 2022 13:22:50 +0000
X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.160)
smtp.mailfrom=nvidia.com;
dkim=none (message not signed)
header.d=none;dmarc=pass action=none header.from=nvidia.com;
Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates
216.228.117.160 as permitted sender) receiver=protection.outlook.com;
client-ip=216.228.117.160; helo=mail.nvidia.com; pr=C
Received: from mail.nvidia.com (216.228.117.160) by
DM6NAM11FT081.mail.protection.outlook.com (10.13.172.136) with Microsoft SMTP
Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
15.20.5746.16 via Frontend Transport; Tue, 25 Oct 2022 13:22:50 +0000
Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com
(10.129.200.66) with Microsoft SMTP Server (version=TLS1_2,
cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.26; Tue, 25 Oct
2022 06:22:44 -0700
Received: from nvidia.com (10.126.231.35) by rnnvmail201.nvidia.com
(10.129.68.8) with Microsoft SMTP Server (version=TLS1_2,
cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.29; Tue, 25 Oct
2022 06:22:43 -0700
From: Ali Alnubani <alialnu@nvidia.com>
To: <dev@dpdk.org>
Subject: [PATCH] lib: remove empty return types from doxygen comments
Date: Tue, 25 Oct 2022 16:22:20 +0300
Message-ID: <20221025132220.3209578-1-alialnu@nvidia.com>
X-Mailer: git-send-email 2.25.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Originating-IP: [10.126.231.35]
X-ClientProxiedBy: rnnvmail202.nvidia.com (10.129.68.7) To
rnnvmail201.nvidia.com (10.129.68.8)
X-EOPAttributedMessage: 0
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DM6NAM11FT081:EE_|BN9PR12MB5355:EE_
X-MS-Office365-Filtering-Correlation-Id: 2d1cda5a-c117-40cd-46d0-08dab68c042d
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: FpQJslznUKJTbkpQOvq4+ygU9aputQQ26Rm1aAgdgn50gj5IIAXMnqrgXzGUODy5AnLZEK2wWtLWdQTVGmX7jlm3vgQfpHj9b+l7gvjWDLleM8nsj5z5SrOCCxO+2n65KgrI9e+ATT/JqUZ6Zpd0FNE5nPc4k5sD2vLS/IBKqp7gafMFC10QJwO0ZlUM4zIv12vCKqSUgFRL+/Bup9YBiD1pT3c86rw5eEmBtIbe+ImiZesHApMD9VjKRFlhvueXoMcO6rH3mUSQBZiUIfKy+/3TL33wnPpWgcWseJE7SDnDktvszMsA3bRbxtYO64XMKEv2CHeLgS1Qrd7YaK43hd6n4xOzCN6uqLUqrCSckZis8zjq+otoCLbCDXTsquFiPcGRGVfypDYmgSlTGNudYn/hyp+AbxgWALSxMZ61LCPOJtStP58awCIB6RhDRGZ0P73oPNg7rO0U1a0XHSLnPFC+WWAFSIl6e7g0rhaeHPIDVaM21+b/hlXNzRbkOg6v+hskbWdJLrNZDt+kpfzRH0mz1MwY5jKrsMVavZoad2OPz93+W/QUQf528uLmW63yN2GB3bJYZC8xyZNujjnolKk8S0LvL7GoHHiwjKaFHkbZ01c+UA/eF/zz+Fuhsf1MF3oJeX3c4DWXdgmErLEZqzww5Ynp4B09WN3nAhPGwZmV4DW8eWB87B78t01dkYrvPA4AZXzzCFLEvQ1MTgmITfDo/MsY/+qoCVsdV0KRvTBy/6XjpFlXZV5dKh/61RXfPFI9NfmLaUndqCEsfPE2YQ==
X-Forefront-Antispam-Report: CIP:216.228.117.160; CTRY:US; LANG:en; SCL:1; SRV:;
IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge1.nvidia.com; CAT:NONE;
SFS:(13230022)(4636009)(346002)(136003)(396003)(376002)(39860400002)(451199015)(40470700004)(36840700001)(46966006)(40480700001)(426003)(356005)(26005)(2906002)(7696005)(40460700003)(8936002)(478600001)(186003)(5660300002)(41300700001)(55016003)(8676002)(47076005)(82740400003)(2616005)(36860700001)(6286002)(316002)(86362001)(70206006)(6916009)(6666004)(336012)(83380400001)(7636003)(82310400005)(1076003)(16526019)(70586007)(36756003);
DIR:OUT; SFP:1101;
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2022 13:22:50.6536 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 2d1cda5a-c117-40cd-46d0-08dab68c042d
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.160];
Helo=[mail.nvidia.com]
X-MS-Exchange-CrossTenant-AuthSource: DM6NAM11FT081.eop-nam11.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN9PR12MB5355
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Recent versions of doxygen (1.9.4 and newer) complain about
the None return types for functions that don't return anything.
Fixes the following build error:
[..]
Generating doc/api/doxygen with a custom command
FAILED: doc/api/html
/usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html
/usr/bin/doxygen doc/api/doxy-api.conf
/root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented
return type for rte_bitmap_prefetch0 that does not return anything
(warning treated as error, aborting now)
[..]
Tested with doxygen versions (1.9.1, 1.9.4, 1.8.17).
Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
---
lib/eal/include/rte_bitmap.h | 2 --
lib/eal/include/rte_hexdump.h | 4 ----
lib/fib/rte_fib.h | 2 --
lib/fib/rte_fib6.h | 2 --
lib/hash/rte_thash.h | 2 --
lib/ipsec/rte_ipsec_sad.h | 2 --
lib/lpm/rte_lpm.h | 2 --
lib/lpm/rte_lpm6.h | 2 --
lib/reorder/rte_reorder.h | 2 --
lib/rib/rte_rib.h | 2 --
lib/rib/rte_rib6.h | 2 --
11 files changed, 24 deletions(-)
diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
index e4623bb176..c589d5cde0 100644
--- a/lib/eal/include/rte_bitmap.h
+++ b/lib/eal/include/rte_bitmap.h
@@ -327,8 +327,6 @@ rte_bitmap_reset(struct rte_bitmap *bmp)
* Handle to bitmap instance
* @param pos
* Bit position
- * @return
- * 0 upon success, error code otherwise
*/
static inline void
rte_bitmap_prefetch0(struct rte_bitmap *bmp, uint32_t pos)
diff --git a/lib/eal/include/rte_hexdump.h b/lib/eal/include/rte_hexdump.h
index 2d03c089c4..80cf2933a7 100644
--- a/lib/eal/include/rte_hexdump.h
+++ b/lib/eal/include/rte_hexdump.h
@@ -27,8 +27,6 @@ extern "C" {
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
extern void
@@ -45,8 +43,6 @@ rte_hexdump(FILE *f, const char * title, const void * buf, unsigned int len);
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
void
diff --git a/lib/fib/rte_fib.h b/lib/fib/rte_fib.h
index baa206093c..d7a5aafe53 100644
--- a/lib/fib/rte_fib.h
+++ b/lib/fib/rte_fib.h
@@ -124,8 +124,6 @@ rte_fib_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib_free(struct rte_fib *fib);
diff --git a/lib/fib/rte_fib6.h b/lib/fib/rte_fib6.h
index 6fc915b1f3..2eb8b82676 100644
--- a/lib/fib/rte_fib6.h
+++ b/lib/fib/rte_fib6.h
@@ -115,8 +115,6 @@ rte_fib6_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib6_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib6_free(struct rte_fib6 *fib);
diff --git a/lib/hash/rte_thash.h b/lib/hash/rte_thash.h
index 451f64043a..c20ff0244c 100644
--- a/lib/hash/rte_thash.h
+++ b/lib/hash/rte_thash.h
@@ -329,8 +329,6 @@ rte_thash_find_existing(const char *name);
*
* @param ctx
* Thash context
- * @return
- * None
*/
__rte_experimental
void
diff --git a/lib/ipsec/rte_ipsec_sad.h b/lib/ipsec/rte_ipsec_sad.h
index a3ae57df7e..dbd89901af 100644
--- a/lib/ipsec/rte_ipsec_sad.h
+++ b/lib/ipsec/rte_ipsec_sad.h
@@ -139,8 +139,6 @@ rte_ipsec_sad_find_existing(const char *name);
*
* @param sad
* pointer to the SAD object
- * @return
- * None
*/
void
rte_ipsec_sad_destroy(struct rte_ipsec_sad *sad);
diff --git a/lib/lpm/rte_lpm.h b/lib/lpm/rte_lpm.h
index c8295905e4..82139c6447 100644
--- a/lib/lpm/rte_lpm.h
+++ b/lib/lpm/rte_lpm.h
@@ -180,8 +180,6 @@ rte_lpm_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm_free(struct rte_lpm *lpm);
diff --git a/lib/lpm/rte_lpm6.h b/lib/lpm/rte_lpm6.h
index cd9ce17989..c93683e624 100644
--- a/lib/lpm/rte_lpm6.h
+++ b/lib/lpm/rte_lpm6.h
@@ -73,8 +73,6 @@ rte_lpm6_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm6_free(struct rte_lpm6 *lpm);
diff --git a/lib/reorder/rte_reorder.h b/lib/reorder/rte_reorder.h
index f72f07e645..4f9f71af75 100644
--- a/lib/reorder/rte_reorder.h
+++ b/lib/reorder/rte_reorder.h
@@ -116,8 +116,6 @@ rte_reorder_reset(struct rte_reorder_buffer *b);
* @param b
* Pointer to reorder buffer instance.
* If b is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_reorder_free(struct rte_reorder_buffer *b);
diff --git a/lib/rib/rte_rib.h b/lib/rib/rte_rib.h
index f41774afe7..2054d3cebd 100644
--- a/lib/rib/rte_rib.h
+++ b/lib/rib/rte_rib.h
@@ -265,8 +265,6 @@ rte_rib_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib_free(struct rte_rib *rib);
diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h
index 49d5b99b70..775286f965 100644
--- a/lib/rib/rte_rib6.h
+++ b/lib/rib/rte_rib6.h
@@ -320,8 +320,6 @@ rte_rib6_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib6_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib6_free(struct rte_rib6 *rib);
--
2.25.1