diff options
| author |   Takashi Iwai <tiwai@suse.de> | 2022-07-13 12:47:54 +0200 |
|---|---|---|
| committer | Takashi Iwai <tiwai@suse.de> | 2022-07-13 13:42:34 +0200 |
| commit | 4e2b70673f2b93ab8e037a2b89c15f146c1ae9b0 (patch) | |
| tree | d834240ad7c19d4b75d264f675ecb06908b649ed /sound/core/pcm.c | |
| parent | ALSA: compress: Enable kernel doc markers for some functions (diff) | |
| download | linux-dev-4e2b70673f2b93ab8e037a2b89c15f146c1ae9b0.tar.xz linux-dev-4e2b70673f2b93ab8e037a2b89c15f146c1ae9b0.zip | |
ALSA: pcm: Fix missing return value comments for kernel docs
Each kernel doc comment expects the definition of the return value in
a proper format. This patch adds or fixes the missing entries for PCM
API.
Link: https://lore.kernel.org/r/20220713104759.4365-3-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core/pcm.c')
| -rw-r--r-- | sound/core/pcm.c | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/sound/core/pcm.c b/sound/core/pcm.c index 977d54320a5c..03fc5fa5813e 100644 --- a/sound/core/pcm.c +++ b/sound/core/pcm.c @@ -216,6 +216,8 @@ static const char * const snd_pcm_format_names[] = { /** * snd_pcm_format_name - Return a name string for the given PCM format * @format: PCM format + * + * Return: the format name string */ const char *snd_pcm_format_name(snd_pcm_format_t format) { @@ -1138,6 +1140,8 @@ static int snd_pcm_dev_disconnect(struct snd_device *device) * This adds the given notifier to the global list so that the callback is * called for each registered PCM devices. This exists only for PCM OSS * emulation, so far. + * + * Return: zero if successful, or a negative error code */ int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree) { |