From: Randy Dunlap <rdunlap@infradead.org>
To: linux-sound@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Liam Girdwood <lgirdwood@gmail.com>,
Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>,
Takashi Iwai <tiwai@suse.com>,
Shengjiu Wang <shengjiu.wang@gmail.com>,
Xiubo Li <Xiubo.Lee@gmail.com>,
Fabio Estevam <festevam@gmail.com>,
Nicolin Chen <nicoleotsuka@gmail.com>,
linuxppc-dev@lists.ozlabs.org,
Charles Keepax <ckeepax@opensource.cirrus.com>,
Maciej Strozek <mstrozek@opensource.cirrus.com>,
Bard Liao <yung-chuan.liao@linux.intel.com>,
Pierre-Louis Bossart <pierre-louis.bossart@linux.dev>,
patches@opensource.cirrus.com,
Srinivas Kandagatla <srini@kernel.org>,
linux-arm-msm@vger.kernel.org
Subject: [PATCH 01/14 v2] ASoC: codecs: NeoFidelity: repair the kernel-doc format
Date: Tue, 14 Jul 2026 17:05:12 -0700 [thread overview]
Message-ID: <20260715000525.739874-2-rdunlap@infradead.org> (raw)
In-Reply-To: <20260715000525.739874-1-rdunlap@infradead.org>
Don't use "/**" for a non-kernel-doc comment.
Use kernel-doc notation to document the parameters and return value of
ntpfw_load().
Fixes these warnings:
Warning: ../sound/soc/codecs/ntpfw.h:2 This comment starts with '/**', but isn't a kernel-doc comment.
* ntpfw.h - Firmware helper functions for Neofidelity codecs
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'i2c' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'name' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'magic' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 No description found for return value of 'ntpfw_load'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: no change
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: linux-sound@vger.kernel.org
sound/soc/codecs/ntpfw.h | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
--- linext-2026-0710.orig/sound/soc/codecs/ntpfw.h
+++ linext-2026-0710/sound/soc/codecs/ntpfw.h
@@ -1,5 +1,5 @@
/* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
* ntpfw.h - Firmware helper functions for Neofidelity codecs
*
* Copyright (c) 2024, SaluteDevices. All Rights Reserved.
@@ -13,10 +13,11 @@
/**
* ntpfw_load - load firmware to amplifier over i2c interface.
*
- * @i2c Pointer to amplifier's I2C client.
- * @name Firmware file name.
- * @magic Magic number to validate firmware.
- * @return 0 or error code upon error.
+ * @i2c: Pointer to amplifier's I2C client.
+ * @name: Firmware file name.
+ * @magic: Magic number to validate firmware.
+ *
+ * Returns: 0 or error code upon error.
*/
int ntpfw_load(struct i2c_client *i2c, const char *name, const u32 magic);
next prev parent reply other threads:[~2026-07-15 0:05 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-15 0:05 [PATCH 00/14 v2] ASoC: clean up kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` Randy Dunlap [this message]
2026-07-15 0:05 ` [PATCH 02/14 v2] ASoC: fsl_asrc_common: fix all " Randy Dunlap
2026-07-15 0:05 ` [PATCH 03/14 v2] ASoC: fsl_asrc: avoid " Randy Dunlap
2026-07-15 0:05 ` [PATCH 04/14 v2] ASoC: fsl-dma: fix all " Randy Dunlap
2026-07-15 0:05 ` [PATCH 05/14 v2] ASoC: fsl_easrc: use struct keyword on structs Randy Dunlap
2026-07-15 0:05 ` [PATCH 06/14 v2] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments Randy Dunlap
2026-07-15 0:05 ` [PATCH 07/14 v2] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` [PATCH 08/14 v2] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions Randy Dunlap
2026-07-15 0:05 ` [PATCH 09/14 v2] ASoC: uniphier: don't use "/**" for non-kernel-doc comment Randy Dunlap
2026-07-15 0:05 ` [PATCH 10/14 v2] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
2026-07-15 0:05 ` [PATCH 11/14 v2] ASoC: soc-acpi: fix all kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` [PATCH 12/14 v2] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format Randy Dunlap
2026-07-15 0:05 ` [PATCH 13/14 v2] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
2026-07-15 0:05 ` [PATCH 14/14 v2] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
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=20260715000525.739874-2-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=Xiubo.Lee@gmail.com \
--cc=broonie@kernel.org \
--cc=ckeepax@opensource.cirrus.com \
--cc=festevam@gmail.com \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mstrozek@opensource.cirrus.com \
--cc=nicoleotsuka@gmail.com \
--cc=patches@opensource.cirrus.com \
--cc=perex@perex.cz \
--cc=pierre-louis.bossart@linux.dev \
--cc=shengjiu.wang@gmail.com \
--cc=srini@kernel.org \
--cc=tiwai@suse.com \
--cc=yung-chuan.liao@linux.intel.com \
/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