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 <[email protected]> --- v2: no change Cc: Liam Girdwood <[email protected]> Cc: Mark Brown <[email protected]> Cc: [email protected] 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);
