From: Takashi Sakamoto Date: Sat, 13 Jun 2020 01:20:47 +0000 (+0900) Subject: hwdep: update documentation with system call information X-Git-Tag: v0.1.0~57 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=7ab96686ed8c993b0a988d8d511d4e044546bc45;p=alsa-gobject.git hwdep: update documentation with system call information Signed-off-by: Takashi Sakamoto --- diff --git a/src/hwdep/query.c b/src/hwdep/query.c index abcf055..4a8b807 100644 --- a/src/hwdep/query.c +++ b/src/hwdep/query.c @@ -132,6 +132,8 @@ static unsigned int calculate_digits(unsigned int number) * @error: A #GError. * * Get the list of numerical ID for available hwdep devices of sound card. + * + * Nodes under sound subsystem in sysfs are used to gather the information. */ void alsahwdep_get_device_id_list(guint card_id, guint **entries, gsize *entry_count, GError **error) @@ -218,6 +220,8 @@ end: * @error: A #GError. * * Allocate sysname for hwdep device and return it when it exists. + * + * Nodes under sound subsystem in sysfs are used to gather the information. */ void alsahwdep_get_hwdep_sysname(guint card_id, guint device_id, char **sysname, GError **error) @@ -263,6 +267,8 @@ void alsahwdep_get_hwdep_sysname(guint card_id, guint device_id, * @error: A #GError. * * Allocate devnode string for hwdep device and return it when exists. + * + * Nodes under sound subsystem in sysfs are used to gather the information. */ void alsahwdep_get_hwdep_devnode(guint card_id, guint device_id, char **devnode, GError **error) @@ -370,6 +376,11 @@ err_sysname: * @device_id: The numerical value of hwdep device to query. * @device_info: (out): The information of the device. * @error: A #GError. + * + * Get the information according to given numerical IDs for card and device. + * + * The call of function executes open(2), close(2), and ioctl(2) system call + * with SNDRV_CTL_IOCTL_HWDEP_INFO command for ALSA control character device. */ void alsahwdep_get_device_info(guint card_id, guint device_id, ALSAHwdepDeviceInfo **device_info,