github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-25 17:42:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

ASoC: codecs: NeoFidelity: repair the kernel-doc format

Browse Source 
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>
Link: https://patch.msgid.link/20260715000525.739874-2-rdunlap@infradead.org
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Randy Dunlap 2026-07-14 17:05:12 -07:00 committed by Mark Brown
parent 92dd0ba8ac
commit 6d29372998
No known key found for this signature in database
GPG Key ID: 24D68B725D5487D0
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sound/soc/codecs/ntpfw.h
View File

@ -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);