ALSA: ac97: Fix kernel-doc warning for snd_ac97_reset
PATCH 1/1 ALSA: ac97: Fix kernel-doc warning for snd_ac97_reset
From: HariKrishna Sagala <[email protected]>
kernel-doc populated the below warning for the non static function "snd_ac97_reset".
"Warning: ./sound/ac97_bus.c:56 No description found for return value of 'snd_ac97_reset'".
Added the return values as per the kernel-doc format.
Signed-off-by HariKrishna Sagala <[email protected]>
--- sound/ac97_bus.c | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
sound/ac97_bus.c +8 -5
@@ -46,11 +46,14 @@ static bool snd_ac97_check_id(struct snd_ac97 *ac97, unsigned int id,* @id_mask: Mask that is applied to the device ID before comparing to @id * * This function resets the AC'97 device. If @try_warm is true the function -* first performs a warm reset. If the warm reset is successful the function -* returns 1. Otherwise or if @try_warm is false the function issues cold reset -* followed by a warm reset. If this is successful the function returns 0, -* otherwise a negative error code. If @id is 0 any valid device ID will be -* accepted, otherwise only the ID that matches @id and @id_mask is accepted. +* first performs a warm reset. If @try_warm is false the function issues +* cold reset followed by a warm reset. If @id is 0 any valid device ID +* will be accepted, otherwise only the ID that matches @id and @id_mask +* is accepted. +* Returns: +* * %1 - if warm reset is successful +* * %0 - if cold reset and warm reset is successful +* * %-ENODEV - if @id and @id_mask not matching */ int snd_ac97_reset (struct snd_ac97 *ac97,bool try_warm,unsigned int id,unsigned int id_mask)
base-commit: 284922f4c563aa3a8558a00f2a05722133237fe8
Signature · 1 line
2.43.0
Quoted 10 lines · On Wed, 05 Nov 2025 11:52:30 +0100, [email protected] wrote:
From: HariKrishna Sagala <[email protected]>
kernel-doc populated the below warning for the non static function "
snd_ac97_reset".
"Warning:./sound/ac97_bus.c:56No description found for return value of 'snd_ac97_reset'".
Added the return values as per the kernel-doc format.Signed-off-by HariKrishna Sagala <[email protected]>
Applied now to for-next branch.
thanks,
Takashi