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/isadma.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/isadma.c')
-rw-r--r-- | sound/core/isadma.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/sound/core/isadma.c b/sound/core/isadma.c index c0f1208bb7df..e2b386156a4c 100644 --- a/sound/core/isadma.c +++ b/sound/core/isadma.c | |||
@@ -81,7 +81,7 @@ EXPORT_SYMBOL(snd_dma_disable); | |||
81 | * @dma: the dma number | 81 | * @dma: the dma number |
82 | * @size: the dma transfer size | 82 | * @size: the dma transfer size |
83 | * | 83 | * |
84 | * Returns the current pointer in DMA tranfer buffer in bytes | 84 | * Return: The current pointer in DMA transfer buffer in bytes. |
85 | */ | 85 | */ |
86 | unsigned int snd_dma_pointer(unsigned long dma, unsigned int size) | 86 | unsigned int snd_dma_pointer(unsigned long dma, unsigned int size) |
87 | { | 87 | { |