tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

ALSA: control: Fix missing return value comments for kernel docs

Each kernel doc comment expects the definition of the return value in
proper format. This patch adds or fixes the missing entries for
control API.

Link: https://lore.kernel.org/r/20220713104759.4365-6-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>

Takashi Iwai e8406ebc b05d834e

+14 -2
+14 -2
sound/core/control.c
··· 2054 2054 * @fcn: ioctl callback function 2055 2055 * 2056 2056 * called from each device manager like pcm.c, hwdep.c, etc. 2057 + * 2058 + * Return: zero if successful, or a negative error code 2057 2059 */ 2058 2060 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn) 2059 2061 { ··· 2068 2066 * snd_ctl_register_ioctl_compat - register the device-specific 32bit compat 2069 2067 * control-ioctls 2070 2068 * @fcn: ioctl callback function 2069 + * 2070 + * Return: zero if successful, or a negative error code 2071 2071 */ 2072 2072 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn) 2073 2073 { ··· 2105 2101 /** 2106 2102 * snd_ctl_unregister_ioctl - de-register the device-specific control-ioctls 2107 2103 * @fcn: ioctl callback function to unregister 2104 + * 2105 + * Return: zero if successful, or a negative error code 2108 2106 */ 2109 2107 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn) 2110 2108 { ··· 2119 2113 * snd_ctl_unregister_ioctl_compat - de-register the device-specific compat 2120 2114 * 32bit control-ioctls 2121 2115 * @fcn: ioctl callback function to unregister 2116 + * 2117 + * Return: zero if successful, or a negative error code 2122 2118 */ 2123 2119 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn) 2124 2120 { ··· 2176 2168 * snd_ctl_request_layer - request to use the layer 2177 2169 * @module_name: Name of the kernel module (NULL == build-in) 2178 2170 * 2179 - * Return an error code when the module cannot be loaded. 2171 + * Return: zero if successful, or an error code when the module cannot be loaded 2180 2172 */ 2181 2173 int snd_ctl_request_layer(const char *module_name) 2182 2174 { ··· 2378 2370 * 2379 2371 * This is a function that can be used as info callback for a standard 2380 2372 * boolean control with a single mono channel. 2373 + * 2374 + * Return: Zero (always successful) 2381 2375 */ 2382 2376 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, 2383 2377 struct snd_ctl_elem_info *uinfo) ··· 2400 2390 * 2401 2391 * This is a function that can be used as info callback for a standard 2402 2392 * boolean control with stereo two channels. 2393 + * 2394 + * Return: Zero (always successful) 2403 2395 */ 2404 2396 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, 2405 2397 struct snd_ctl_elem_info *uinfo) ··· 2425 2413 * If the control's accessibility is not the default (readable and writable), 2426 2414 * the caller has to fill @info->access. 2427 2415 * 2428 - * Return: Zero. 2416 + * Return: Zero (always successful) 2429 2417 */ 2430 2418 int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels, 2431 2419 unsigned int items, const char *const names[])