diff options
| author | Yacine Belkadi <yacine.belkadi.1@gmail.com> | 2013-03-11 22:05:14 +0100 |
|---|---|---|
| committer | Takashi Iwai <tiwai@suse.de> | 2013-03-12 08:32:53 +0100 |
| commit | eb7c06e8e9c93b495e355421cffd3c43c266d7d2 (patch) | |
| tree | f53aa110b92ff941f5d2d84d6ee38b1a45b3e005 /sound/core/memory.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/memory.c')
| -rw-r--r-- | sound/core/memory.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/sound/core/memory.c b/sound/core/memory.c index 66a278d0b04..36c0f1a2e18 100644 --- a/sound/core/memory.c +++ b/sound/core/memory.c @@ -33,7 +33,7 @@ * * Copies the data from mmio-space to user-space. * - * Returns zero if successful, or non-zero on failure. + * Return: Zero if successful, or non-zero on failure. */ int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count) { @@ -66,7 +66,7 @@ EXPORT_SYMBOL(copy_to_user_fromio); * * Copies the data from user-space to mmio-space. * - * Returns zero if successful, or non-zero on failure. + * Return: Zero if successful, or non-zero on failure. */ int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count) { |