mirror of
https://github.com/torvalds/linux
synced 2024-09-06 18:01:05 +00:00
ALSA: fix kernel-doc markups
Kernel-doc markups should use this format: identifier - description There is a common comment marked, instead, with kernel-doc notation. Some identifiers have different names between their prototypes and the kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by: Mark Brown <broonie@kernel.org> Link: https://lore.kernel.org/r/535182d6f55d7a7de293dda9676df68f5f60afc6.1603469755.git.mchehab+huawei@kernel.org Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
parent
3650b228f8
commit
f7b6603c66
|
@ -332,7 +332,8 @@ void __snd_printk(unsigned int level, const char *file, int line,
|
|||
#define snd_BUG() WARN(1, "BUG?\n")
|
||||
|
||||
/**
|
||||
* Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
|
||||
* snd_printd_ratelimit - Suppress high rates of output when
|
||||
* CONFIG_SND_DEBUG is enabled.
|
||||
*/
|
||||
#define snd_printd_ratelimit() printk_ratelimit()
|
||||
|
||||
|
|
|
@ -1284,8 +1284,8 @@ snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
|
|||
}
|
||||
|
||||
/**
|
||||
* snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
|
||||
* page from the given size
|
||||
* snd_pcm_sgbuf_get_chunk_size - Compute the max size that fits within the
|
||||
* contig. page from the given size
|
||||
* @substream: PCM substream
|
||||
* @ofs: byte offset
|
||||
* @size: byte size to examine
|
||||
|
|
|
@ -144,7 +144,7 @@ struct snd_compr_metadata {
|
|||
__u32 value[8];
|
||||
} __attribute__((packed, aligned(4)));
|
||||
|
||||
/**
|
||||
/*
|
||||
* compress path ioctl definitions
|
||||
* SNDRV_COMPRESS_GET_CAPS: Query capability of DSP
|
||||
* SNDRV_COMPRESS_GET_CODEC_CAPS: Query capability of a codec
|
||||
|
|
|
@ -1925,8 +1925,8 @@ EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
|
|||
|
||||
#ifdef CONFIG_COMPAT
|
||||
/**
|
||||
* snd_ctl_unregister_ioctl - de-register the device-specific compat 32bit
|
||||
* control-ioctls
|
||||
* snd_ctl_unregister_ioctl_compat - de-register the device-specific compat
|
||||
* 32bit control-ioctls
|
||||
* @fcn: ioctl callback function to unregister
|
||||
*/
|
||||
int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
|
||||
|
|
|
@ -356,7 +356,8 @@ int snd_dmaengine_pcm_close(struct snd_pcm_substream *substream)
|
|||
EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_close);
|
||||
|
||||
/**
|
||||
* snd_dmaengine_pcm_release_chan_close - Close a dmaengine based PCM substream and release channel
|
||||
* snd_dmaengine_pcm_close_release_chan - Close a dmaengine based PCM
|
||||
* substream and release channel
|
||||
* @substream: PCM substream
|
||||
*
|
||||
* Releases the DMA channel associated with the PCM substream.
|
||||
|
|
|
@ -490,7 +490,7 @@ void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
|
|||
EXPORT_SYMBOL(snd_pcm_set_ops);
|
||||
|
||||
/**
|
||||
* snd_pcm_sync - set the PCM sync id
|
||||
* snd_pcm_set_sync - set the PCM sync id
|
||||
* @substream: the pcm substream
|
||||
*
|
||||
* Sets the PCM sync identifier for the card.
|
||||
|
|
|
@ -112,7 +112,7 @@ void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
|
|||
EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
|
||||
|
||||
/**
|
||||
* snd_pcm_stream_lock - Unlock the PCM stream
|
||||
* snd_pcm_stream_unlock - Unlock the PCM stream
|
||||
* @substream: PCM substream
|
||||
*
|
||||
* This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
|
||||
|
@ -595,7 +595,7 @@ static void snd_pcm_sync_stop(struct snd_pcm_substream *substream)
|
|||
}
|
||||
|
||||
/**
|
||||
* snd_pcm_hw_param_choose - choose a configuration defined by @params
|
||||
* snd_pcm_hw_params_choose - choose a configuration defined by @params
|
||||
* @pcm: PCM instance
|
||||
* @params: the hw_params instance
|
||||
*
|
||||
|
|
|
@ -2341,7 +2341,7 @@ struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
|
|||
}
|
||||
|
||||
/**
|
||||
* snd_soc_unregister_dai - Unregister DAIs from the ASoC core
|
||||
* snd_soc_unregister_dais - Unregister DAIs from the ASoC core
|
||||
*
|
||||
* @component: The component for which the DAIs should be unregistered
|
||||
*/
|
||||
|
|
|
@ -1276,7 +1276,7 @@ static int is_connected_input_ep(struct snd_soc_dapm_widget *widget,
|
|||
}
|
||||
|
||||
/**
|
||||
* snd_soc_dapm_get_connected_widgets - query audio path and it's widgets.
|
||||
* snd_soc_dapm_dai_get_connected_widgets - query audio path and it's widgets.
|
||||
* @dai: the soc DAI.
|
||||
* @stream: stream direction.
|
||||
* @list: list of active widgets for this stream.
|
||||
|
|
Loading…
Reference in a new issue