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 /include/sound/core.h | |
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 'include/sound/core.h')
-rw-r--r-- | include/sound/core.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/sound/core.h b/include/sound/core.h index a63680b9819d..5bfe5136441c 100644 --- a/include/sound/core.h +++ b/include/sound/core.h | |||
@@ -229,7 +229,7 @@ int snd_register_device_for_dev(int type, struct snd_card *card, | |||
229 | * This function uses the card's device pointer to link to the | 229 | * This function uses the card's device pointer to link to the |
230 | * correct &struct device. | 230 | * correct &struct device. |
231 | * | 231 | * |
232 | * Returns zero if successful, or a negative error code on failure. | 232 | * Return: Zero if successful, or a negative error code on failure. |
233 | */ | 233 | */ |
234 | static inline int snd_register_device(int type, struct snd_card *card, int dev, | 234 | static inline int snd_register_device(int type, struct snd_card *card, int dev, |
235 | const struct file_operations *f_ops, | 235 | const struct file_operations *f_ops, |