From patchwork Wed Nov 9 14:54:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jerin Jacob Kollanukkaran X-Patchwork-Id: 119616 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5C31DA034C; Wed, 9 Nov 2022 15:54:35 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 85735410EF; Wed, 9 Nov 2022 15:54:32 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 83514410DE; Wed, 9 Nov 2022 15:54:30 +0100 (CET) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 2A98eJwi011834; Wed, 9 Nov 2022 06:54:29 -0800 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=3EUZMSFOrw3m4hpjGZX8X9ScF7UV9lALrxklhJBEVqI=; b=C4iXhWFe7bS4vId9JZuFxLkjiFfusaOYKq01quIKLlPVTynmkq9i3BYbtdd3Hs10z5ll 1cVaM+McnNx+PIn8RQ09w34oNd+PiR4bUmBZ02bT1YnQvGok53OS2oBghCqIJUorhCJY 0dTb2puw4d/cl2XELgOB2BQ+BeWwOpU7wl1mZZ5yNbM5VLbKNu6nSLiEC2DuzR0U/xCL eVnKrCLuPZAHf0RDkOz+Wx3xwa+2re4h34S2zcBj7750clmHdhFKQ7/pqtQvjrfT1IIl DIlo6OxnavY4mIn+h+XOexasY8CDbjLebuHZN3tndY3LJtQn68UXnm8ewOoOWZcPVM4y Uw== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3kr8wbs6ae-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Wed, 09 Nov 2022 06:54:29 -0800 Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Wed, 9 Nov 2022 06:54:23 -0800 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server id 15.0.1497.2 via Frontend Transport; Wed, 9 Nov 2022 06:54:23 -0800 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id 1D3303F70A4; Wed, 9 Nov 2022 06:54:20 -0800 (PST) From: To: , David Hunt , Stephen Hemminger CC: , , Jerin Jacob , Subject: [dpdk-dev] [PATCH] lib: fix doxygen syntax issues Date: Wed, 9 Nov 2022 20:24:10 +0530 Message-ID: <20221109145410.411708-1-jerinj@marvell.com> X-Mailer: git-send-email 2.38.1 MIME-Version: 1.0 X-Proofpoint-GUID: RUutUrDNvr8r1O_dLvtuz49mwXfz8GLw X-Proofpoint-ORIG-GUID: RUutUrDNvr8r1O_dLvtuz49mwXfz8GLw X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.895,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2022-11-09_06,2022-11-09_01,2022-06-22_01 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jerin Jacob Fix following syntax error reported by doxygen 1.9.5 version. lib/eal/include/rte_uuid.h:89: error: RTE_UUID_STRLEN has @param documentation sections but no arguments (warning treated as error, aborting now) lib/power/rte_power.h:169: error: rte_power_freq_up has @param documentation sections but no arguments (warning treated as error, aborting now) Fixes: 6bc67c497a51 ("eal: add uuid API") Fixes: d7937e2e3d12 ("power: initial import") Cc: stable@dpdk.org Signed-off-by: Jerin Jacob --- lib/eal/include/rte_uuid.h | 4 ++- lib/power/rte_power.h | 55 -------------------------------------- 2 files changed, 3 insertions(+), 56 deletions(-) diff --git a/lib/eal/include/rte_uuid.h b/lib/eal/include/rte_uuid.h index 8b42e070af..cfefd4308a 100644 --- a/lib/eal/include/rte_uuid.h +++ b/lib/eal/include/rte_uuid.h @@ -37,6 +37,9 @@ typedef unsigned char rte_uuid_t[16]; ((e) >> 8) & 0xff, (e) & 0xff \ } +/** UUID string length */ +#define RTE_UUID_STRLEN (36 + 1) + /** * Test if UUID is all zeros. * @@ -95,7 +98,6 @@ int rte_uuid_parse(const char *in, rte_uuid_t uu); * @param len * Sizeof the available string buffer */ -#define RTE_UUID_STRLEN (36 + 1) void rte_uuid_unparse(const rte_uuid_t uu, char *out, size_t len); #ifdef __cplusplus diff --git a/lib/power/rte_power.h b/lib/power/rte_power.h index 47345e26df..7954299489 100644 --- a/lib/power/rte_power.h +++ b/lib/power/rte_power.h @@ -169,14 +169,6 @@ typedef int (*rte_power_freq_change_t)(unsigned int lcore_id); * Scale up the frequency of a specific lcore according to the available * frequencies. * Review each environments specific documentation for usage. - * - * @param lcore_id - * lcore id. - * - * @return - * - 1 on success with frequency changed. - * - 0 on success without frequency changed. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_freq_up; @@ -184,30 +176,13 @@ extern rte_power_freq_change_t rte_power_freq_up; * Scale down the frequency of a specific lcore according to the available * frequencies. * Review each environments specific documentation for usage. - * - * @param lcore_id - * lcore id. - * - * @return - * - 1 on success with frequency changed. - * - 0 on success without frequency changed. - * - Negative on error. */ - extern rte_power_freq_change_t rte_power_freq_down; /** * Scale up the frequency of a specific lcore to the highest according to the * available frequencies. * Review each environments specific documentation for usage. - * - * @param lcore_id - * lcore id. - * - * @return - * - 1 on success with frequency changed. - * - 0 on success without frequency changed. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_freq_max; @@ -215,54 +190,24 @@ extern rte_power_freq_change_t rte_power_freq_max; * Scale down the frequency of a specific lcore to the lowest according to the * available frequencies. * Review each environments specific documentation for usage.. - * - * @param lcore_id - * lcore id. - * - * @return - * - 1 on success with frequency changed. - * - 0 on success without frequency changed. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_freq_min; /** * Query the Turbo Boost status of a specific lcore. * Review each environments specific documentation for usage.. - * - * @param lcore_id - * lcore id. - * - * @return - * - 1 Turbo Boost is enabled for this lcore. - * - 0 Turbo Boost is disabled for this lcore. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_turbo_status; /** * Enable Turbo Boost for this lcore. * Review each environments specific documentation for usage.. - * - * @param lcore_id - * lcore id. - * - * @return - * - 0 on success. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_freq_enable_turbo; /** * Disable Turbo Boost for this lcore. * Review each environments specific documentation for usage.. - * - * @param lcore_id - * lcore id. - * - * @return - * - 0 on success. - * - Negative on error. */ extern rte_power_freq_change_t rte_power_freq_disable_turbo;