ALSA: add/change some comments describing function return values
authorYacine Belkadi <yacine.belkadi.1@gmail.com>
Mon, 11 Mar 2013 21:05:14 +0000 (22:05 +0100)
committerTakashi Iwai <tiwai@suse.de>
Tue, 12 Mar 2013 07:32:53 +0000 (08:32 +0100)
commiteb7c06e8e9c93b495e355421cffd3c43c266d7d2
treef53aa110b92ff941f5d2d84d6ee38b1a45b3e005
parenta817650ebb451ef27db2baa7e10d0c28609bed13
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>
24 files changed:
include/sound/control.h
include/sound/core.h
include/sound/pcm.h
sound/core/control.c
sound/core/device.c
sound/core/hwdep.c
sound/core/info.c
sound/core/init.c
sound/core/isadma.c
sound/core/jack.c
sound/core/memalloc.c
sound/core/memory.c
sound/core/pcm.c
sound/core/pcm_lib.c
sound/core/pcm_memory.c
sound/core/pcm_misc.c
sound/core/pcm_native.c
sound/core/rawmidi.c
sound/core/sound.c
sound/core/vmaster.c
sound/drivers/mpu401/mpu401_uart.c
sound/pci/ac97/ac97_codec.c
sound/pci/ac97/ac97_pcm.c
sound/sound_core.c