Commit f7b6603c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Takashi Iwai
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarMark Brown <broonie@kernel.org>
Link: https://lore.kernel.org/r/535182d6f55d7a7de293dda9676df68f5f60afc6.1603469755.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 3650b228

include/sound/core.h

+2 −1
Original line number Diff line number Diff line
@@ -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()

include/sound/pcm.h

+2 −2
Original line number Diff line number Diff line
@@ -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

include/uapi/sound/compress_offload.h

+1 −1
Original line number Diff line number Diff line
@@ -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

sound/core/control.c

+2 −2
Original line number Diff line number Diff line
@@ -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)

sound/core/pcm_dmaengine.c

+2 −1
Original line number Diff line number Diff line
@@ -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.

CRA Git | Maintained and supported by SUSTech CRA and CCSE