Commit df8db936 authored by Takashi Iwai's avatar Takashi Iwai Committed by Jaroslav Kysela

[ALSA] Fix DocBook warnings

PCM Midlevel,RawMidi Midlevel
Fix DocBook warnings.
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent ec9e1c5c
This diff is collapsed.
...@@ -244,7 +244,7 @@ int snd_pcm_lib_preallocate_pages(snd_pcm_substream_t *substream, ...@@ -244,7 +244,7 @@ int snd_pcm_lib_preallocate_pages(snd_pcm_substream_t *substream,
/** /**
* snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams) * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams)
* @substream: the pcm substream instance * @pcm: the pcm instance
* @type: DMA type (SNDRV_DMA_TYPE_*) * @type: DMA type (SNDRV_DMA_TYPE_*)
* @data: DMA type dependant data * @data: DMA type dependant data
* @size: the requested pre-allocation size in bytes * @size: the requested pre-allocation size in bytes
......
...@@ -859,6 +859,7 @@ static struct action_ops snd_pcm_action_start = { ...@@ -859,6 +859,7 @@ static struct action_ops snd_pcm_action_start = {
/** /**
* snd_pcm_start * snd_pcm_start
* @substream: the PCM substream instance
* *
* Start all linked streams. * Start all linked streams.
*/ */
...@@ -908,6 +909,8 @@ static struct action_ops snd_pcm_action_stop = { ...@@ -908,6 +909,8 @@ static struct action_ops snd_pcm_action_stop = {
/** /**
* snd_pcm_stop * snd_pcm_stop
* @substream: the PCM substream instance
* @state: PCM state after stopping the stream
* *
* Try to stop all running streams in the substream group. * Try to stop all running streams in the substream group.
* The state of each stream is changed to the given value after that unconditionally. * The state of each stream is changed to the given value after that unconditionally.
...@@ -919,6 +922,7 @@ int snd_pcm_stop(snd_pcm_substream_t *substream, int state) ...@@ -919,6 +922,7 @@ int snd_pcm_stop(snd_pcm_substream_t *substream, int state)
/** /**
* snd_pcm_drain_done * snd_pcm_drain_done
* @substream: the PCM substream
* *
* Stop the DMA only when the given stream is playback. * Stop the DMA only when the given stream is playback.
* The state is changed to SETUP. * The state is changed to SETUP.
...@@ -1040,6 +1044,7 @@ static struct action_ops snd_pcm_action_suspend = { ...@@ -1040,6 +1044,7 @@ static struct action_ops snd_pcm_action_suspend = {
/** /**
* snd_pcm_suspend * snd_pcm_suspend
* @substream: the PCM substream
* *
* Trigger SUSPEND to all linked streams. * Trigger SUSPEND to all linked streams.
* After this call, all streams are changed to SUSPENDED state. * After this call, all streams are changed to SUSPENDED state.
...@@ -1057,6 +1062,7 @@ int snd_pcm_suspend(snd_pcm_substream_t *substream) ...@@ -1057,6 +1062,7 @@ int snd_pcm_suspend(snd_pcm_substream_t *substream)
/** /**
* snd_pcm_suspend_all * snd_pcm_suspend_all
* @pcm: the PCM instance
* *
* Trigger SUSPEND to all substreams in the given pcm. * Trigger SUSPEND to all substreams in the given pcm.
* After this call, all streams are changed to SUSPENDED state. * After this call, all streams are changed to SUSPENDED state.
...@@ -1272,6 +1278,9 @@ static struct action_ops snd_pcm_action_prepare = { ...@@ -1272,6 +1278,9 @@ static struct action_ops snd_pcm_action_prepare = {
/** /**
* snd_pcm_prepare * snd_pcm_prepare
* @substream: the PCM substream instance
*
* Prepare the PCM substream to be triggerable.
*/ */
int snd_pcm_prepare(snd_pcm_substream_t *substream) int snd_pcm_prepare(snd_pcm_substream_t *substream)
{ {
......
...@@ -1109,7 +1109,7 @@ int snd_rawmidi_transmit_ack(snd_rawmidi_substream_t * substream, int count) ...@@ -1109,7 +1109,7 @@ int snd_rawmidi_transmit_ack(snd_rawmidi_substream_t * substream, int count)
/** /**
* snd_rawmidi_transmit - copy from the buffer to the device * snd_rawmidi_transmit - copy from the buffer to the device
* @substream: the rawmidi substream * @substream: the rawmidi substream
* @buf: the buffer pointer * @buffer: the buffer pointer
* @count: the data size to transfer * @count: the data size to transfer
* *
* Copies data from the buffer to the device and advances the pointer. * Copies data from the buffer to the device and advances the pointer.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment