diff options
author | Yacine Belkadi <yacine.belkadi.1@gmail.com> | 2013-03-11 17:05:14 -0400 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2013-03-12 03:32:53 -0400 |
commit | eb7c06e8e9c93b495e355421cffd3c43c266d7d2 (patch) | |
tree | f53aa110b92ff941f5d2d84d6ee38b1a45b3e005 /sound/core/hwdep.c | |
parent | a817650ebb451ef27db2baa7e10d0c28609bed13 (diff) |
ALSA: add/change some comments describing function return values
script/kernel-doc reports the following type of warnings (when run in verbose
mode):
Warning(sound/core/init.c:152): No description found for return value of
'snd_card_create'
To fix that:
- add missing descriptions of function return values
- use "Return:" sections to describe those return values
Along the way:
- complete some descriptions
- fix some typos
Signed-off-by: Yacine Belkadi <yacine.belkadi.1@gmail.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core/hwdep.c')
-rw-r--r-- | sound/core/hwdep.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/sound/core/hwdep.c b/sound/core/hwdep.c index 3f7f6628cf7b..d105073298cb 100644 --- a/sound/core/hwdep.c +++ b/sound/core/hwdep.c | |||
@@ -356,7 +356,7 @@ static const struct file_operations snd_hwdep_f_ops = | |||
356 | * The callbacks (hwdep->ops) must be set on the returned instance | 356 | * The callbacks (hwdep->ops) must be set on the returned instance |
357 | * after this call manually by the caller. | 357 | * after this call manually by the caller. |
358 | * | 358 | * |
359 | * Returns zero if successful, or a negative error code on failure. | 359 | * Return: Zero if successful, or a negative error code on failure. |
360 | */ | 360 | */ |
361 | int snd_hwdep_new(struct snd_card *card, char *id, int device, | 361 | int snd_hwdep_new(struct snd_card *card, char *id, int device, |
362 | struct snd_hwdep **rhwdep) | 362 | struct snd_hwdep **rhwdep) |