diff options
author | Takashi Iwai <tiwai@suse.de> | 2009-02-09 14:47:19 +0100 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2009-03-09 15:10:01 +0100 |
commit | 79c7cdd5441f5d3900c1632adcc8cd2bee35c8da (patch) | |
tree | 13eec2a208f2d07d05bfb3e33b8869f6adecc2bd /sound/core | |
parent | ALSA: add snd_ctl_add_slave_uncached() (diff) | |
download | linux-79c7cdd5441f5d3900c1632adcc8cd2bee35c8da.tar.xz linux-79c7cdd5441f5d3900c1632adcc8cd2bee35c8da.zip |
ALSA: Add kernel-doc comments to vmaster stuff
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core')
-rw-r--r-- | sound/core/vmaster.c | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/sound/core/vmaster.c b/sound/core/vmaster.c index d51b198d06d9..257624bd1997 100644 --- a/sound/core/vmaster.c +++ b/sound/core/vmaster.c @@ -340,8 +340,20 @@ static void master_free(struct snd_kcontrol *kcontrol) } -/* - * Create a virtual master control with the given name +/** + * snd_ctl_make_virtual_master - Create a virtual master control + * @name: name string of the control element to create + * @tlv: optional TLV int array for dB information + * + * Creates a virtual matster control with the given name string. + * Returns the created control element, or NULL for errors (ENOMEM). + * + * After creating a vmaster element, you can add the slave controls + * via snd_ctl_add_slave() or snd_ctl_add_slave_uncached(). + * + * The optional argument @tlv can be used to specify the TLV information + * for dB scale of the master control. It should be a single element + * with #SNDRV_CTL_TLVT_DB_SCALE type, and should be the max 0dB. */ struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, const unsigned int *tlv) |