Skip to contentSkip to conversation

sound: add missing pcm kernel-doc

PATCH Applied Randy Dunlap 2 participants 2 messages Oct 17, 2008 – Oct 18, 2008 Sound

lore
Share & tools
lore

Randy Dunlap

author
#0 lore raw

PATCH 1/1 sound: add missing pcm kernel-doc

From: Randy Dunlap <[email protected]>

Fix alsa kernel-doc warning in linux-next:

Warning(linux-next-20081016//sound/core/pcm_misc.c:327): No description found for parameter 'samples'

Signed-off-by Randy Dunlap <[email protected]>
---
 sound/core/pcm_misc.c |    1 +
 1 file changed, 1 insertion(+)
sound/core/pcm_misc.c +1 -0
@@ -319,6 +319,7 @@ EXPORT_SYMBOL(snd_pcm_format_physical_wi
 /**
  * snd_pcm_format_size - return the byte size of samples on the given format
  * @format: the format to check
+ * @samples: sampling rate
  *
  * Returns the byte size of the given samples for the format, or a
  * negative error code if unknown format.
Applied
#1 lore raw

At Fri, 17 Oct 2008 11:28:11 -0700,

Quoted 8 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix alsa kernel-doc warning in linux-next:

Warning(linux-next-20081016//sound/core/pcm_misc.c:327): No description found for parameter 'samples'

Signed-off-by Randy Dunlap <[email protected]>

Thanks, applied now to sound tree.

Takashi

Quoted 15 lines
---
 sound/core/pcm_misc.c |    1 +
 1 file changed, 1 insertion(+)
sound/core/pcm_misc.c +1 -0
@@ -319,6 +319,7 @@ EXPORT_SYMBOL(snd_pcm_format_physical_wi
 /**
  * snd_pcm_format_size - return the byte size of samples on the given format
  * @format: the format to check
+ * @samples: sampling rate
  *
  * Returns the byte size of the given samples for the format, or a
  * negative error code if unknown format.