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/sound.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/sound.c')
-rw-r--r-- | sound/core/sound.c | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/sound/core/sound.c b/sound/core/sound.c index 70ccdab74153..f002bd911dae 100644 --- a/sound/core/sound.c +++ b/sound/core/sound.c | |||
@@ -102,6 +102,9 @@ static void snd_request_other(int minor) | |||
102 | * This function increments the reference counter of the card instance | 102 | * This function increments the reference counter of the card instance |
103 | * if an associated instance with the given minor number and type is found. | 103 | * if an associated instance with the given minor number and type is found. |
104 | * The caller must call snd_card_unref() appropriately later. | 104 | * The caller must call snd_card_unref() appropriately later. |
105 | * | ||
106 | * Return: The user data pointer if the specified device is found. %NULL | ||
107 | * otherwise. | ||
105 | */ | 108 | */ |
106 | void *snd_lookup_minor_data(unsigned int minor, int type) | 109 | void *snd_lookup_minor_data(unsigned int minor, int type) |
107 | { | 110 | { |
@@ -261,7 +264,7 @@ static int snd_kernel_minor(int type, struct snd_card *card, int dev) | |||
261 | * Registers an ALSA device file for the given card. | 264 | * Registers an ALSA device file for the given card. |
262 | * The operators have to be set in reg parameter. | 265 | * The operators have to be set in reg parameter. |
263 | * | 266 | * |
264 | * Returns zero if successful, or a negative error code on failure. | 267 | * Return: Zero if successful, or a negative error code on failure. |
265 | */ | 268 | */ |
266 | int snd_register_device_for_dev(int type, struct snd_card *card, int dev, | 269 | int snd_register_device_for_dev(int type, struct snd_card *card, int dev, |
267 | const struct file_operations *f_ops, | 270 | const struct file_operations *f_ops, |
@@ -339,7 +342,7 @@ static int find_snd_minor(int type, struct snd_card *card, int dev) | |||
339 | * Unregisters the device file already registered via | 342 | * Unregisters the device file already registered via |
340 | * snd_register_device(). | 343 | * snd_register_device(). |
341 | * | 344 | * |
342 | * Returns zero if sucecessful, or a negative error code on failure | 345 | * Return: Zero if successful, or a negative error code on failure. |
343 | */ | 346 | */ |
344 | int snd_unregister_device(int type, struct snd_card *card, int dev) | 347 | int snd_unregister_device(int type, struct snd_card *card, int dev) |
345 | { | 348 | { |