From 17414dc13f0618f2d80e1b2d492a07f781859992 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 01/23] ctl: card: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/ctl/card.c | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/ctl/card.c b/src/ctl/card.c index 8b0bfbb3..26e9dd56 100644 --- a/src/ctl/card.c +++ b/src/ctl/card.c @@ -116,12 +116,22 @@ static void alsactl_card_class_init(ALSACtlCardClass *klass) gobject_class->finalize = ctl_card_finalize; gobject_class->get_property = ctl_card_get_property; + /** + * ALSACtlCard:devnode: + * + * The full path to special file of control character device. + */ ctl_card_props[CTL_CARD_PROP_DEVNODE] = g_param_spec_string("devnode", "devnode", - "The full path of control character device.", + "The full path to special file of control character device.", "", G_PARAM_READABLE); + /** + * ALSACtlCard:subscribed: + * + * Whether to be subscribed for event. + */ ctl_card_props[CTL_CARD_PROP_SUBSCRIBED] = g_param_spec_boolean("subscribed", "subscribed", "Whether to be subscribed for event.", From 71d0444862b78c3f54f2e6fb95cefa8b8b9bc23d Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 02/23] ctl: card-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/ctl/card-info.c | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/src/ctl/card-info.c b/src/ctl/card-info.c index 0cf9da21..f71b975f 100644 --- a/src/ctl/card-info.c +++ b/src/ctl/card-info.c @@ -67,43 +67,78 @@ static void alsactl_card_info_class_init(ALSACtlCardInfoClass *klass) gobject_class->get_property = ctl_card_info_get_property; + /** + * ALSACtlCardInfo:card-id: + * + * The numeric ID of sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card.", + "The numeric ID of sound card.", G_MININT, G_MAXINT, -1, G_PARAM_READABLE); + /** + * ALSACtlCardInfo:id: + * + * The string ID of sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_ID] = g_param_spec_string("id", "id", "The string ID of sound card.", "", G_PARAM_READABLE); + /** + * ALSACtlCardInfo:driver: + * + * The name of driver bound to the sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_DRIVER] = g_param_spec_string("driver", "driver", "The name of driver bound to the sound card.", "", G_PARAM_READABLE); + /** + * ALSACtlCardInfo:name: + * + * The name of sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of sound card.", "", G_PARAM_READABLE); + /** + * ALSACtlCardInfo:long-name: + * + * The long name of sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_LONG_NAME] = g_param_spec_string("long-name", "long-name", "The long name of sound card.", "", G_PARAM_READABLE); + /** + * ALSACtlCardInfo:mixer-name: + * + * The name of mixer for the sound card. + */ ctl_card_info_props[CTL_CARD_INFO_PROP_MIXER_NAME] = g_param_spec_string("mixer-name", "mixer-name", "The name of mixer for the sound card.", "", G_PARAM_READABLE); + /** + * ALSACtlCardInfo:components: + * + * The The string with space-separated components for the sound card., + */ ctl_card_info_props[CTL_CARD_INFO_PROP_COMPONENTS] = g_param_spec_string("components", "components", "The The string with space-separated components " From fb75331f12e6f492799c92963e424e64a64d3ef4 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 03/23] card: elem-value: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/ctl/elem-value.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/ctl/elem-value.c b/src/ctl/elem-value.c index ae214443..615e8faf 100644 --- a/src/ctl/elem-value.c +++ b/src/ctl/elem-value.c @@ -49,6 +49,11 @@ static void alsactl_elem_value_class_init(ALSACtlElemValueClass *klass) gobject_class->get_property = ctl_elem_value_get_property; + /** + * ALSACtlElemValue:elem-id: + * + * The identifier of element. + */ ctl_elem_value_props[CTL_ELEM_VALUE_PROP_ELEM_ID] = g_param_spec_boxed("elem-id", "elem-id", "The identifier of element", From 9a2f02620101f8d1004dc1b947fd23a25c8ed5d1 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 04/23] rawmidi: stream-pair: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/rawmidi/stream-pair.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/rawmidi/stream-pair.c b/src/rawmidi/stream-pair.c index bed02462..425031dd 100644 --- a/src/rawmidi/stream-pair.c +++ b/src/rawmidi/stream-pair.c @@ -115,9 +115,14 @@ static void alsarawmidi_stream_pair_class_init(ALSARawmidiStreamPairClass *klass gobject_class->finalize = rawmidi_stream_pair_finalize; gobject_class->get_property = rawmidi_stream_pair_get_property; + /** + * ALSARawmidiStreamPair:devnode: + * + * The full path to special file of rawmidi character device. + */ rawmidi_stream_pair_props[RAWMIDI_STREAM_PAIR_PROP_DEVNODE] = g_param_spec_string("devnode", "devnode", - "The full path of rawmidi character device.", + "The full path to special file of rawmidi character device.", "", G_PARAM_READABLE); From e862d300104bb6cb91dcf6e36cf8cc18d8b987b7 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 05/23] rawmidi: substream-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/rawmidi/substream-info.c | 66 +++++++++++++++++++++++++++++++----- 1 file changed, 57 insertions(+), 9 deletions(-) diff --git a/src/rawmidi/substream-info.c b/src/rawmidi/substream-info.c index ed272211..397e5373 100644 --- a/src/rawmidi/substream-info.c +++ b/src/rawmidi/substream-info.c @@ -81,62 +81,105 @@ static void alsarawmidi_substream_info_class_init(ALSARawmidiSubstreamInfoClass gobject_class->get_property = rawmidi_substream_info_get_property; + /** + * ALSARawmidiSubstreamInfo:device-id: + * + * The numeric identifier of rawmidi device. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_DEVICE_ID] = g_param_spec_uint("device-id", "device-id", - "The numerical identifier of rawmidi device.", + "The numeric identifier of rawmidi device.", 0, G_MAXINT, 0, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:subdevice-id: + * + * The numeric identifier of subdevice or rawmidi device. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_SUBDEVICE_ID] = g_param_spec_uint("subdevice-id", "subdevice-id", - "The numerical identifier of subdevice for rawmidi device..", + "The numeric identifier of subdevice for rawmidi device..", 0, G_MAXINT, 0, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:direction: + * + * The direction of stream, one of [enum@StreamDirection]. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_DIRECTION] = g_param_spec_enum("direction", "direction", - "The direction of stream, one of " - "ALSARawmidiStreamDirection", + "The direction of stream, one of ALSARawmidiStreamDirection", ALSARAWMIDI_TYPE_STREAM_DIRECTION, ALSARAWMIDI_STREAM_DIRECTION_OUTPUT, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:card-id: + * + * The numeric identifier of sound card. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical identifier of sound card.", + "The numeric identifier of sound card.", G_MININT, G_MAXINT, -1, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:flags: + * + * The information flags of rawmidi device with flags of [flags@StreamPairInfoFlag]. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_FLAGS] = g_param_spec_flags("flags", "flags", - "The information flags of rawmidi device with flags " - "of ALSARawmidiStreamPairInfoFlag.", + "The information flags of rawmidi device with flags of " + "ALSARawmidiStreamPairInfoFlag.", ALSARAWMIDI_TYPE_STREAM_PAIR_INFO_FLAG, 0, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:id: + * + * The string identifier of rawmidi device. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_ID] = g_param_spec_string("id", "id", "The string identifier of rawmidi device.", "", G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:name: + * + * The name of rawmidi device. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of rawmidi device.", "", G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:subdevice-name: + * + * The name of subdevice for the direction and the [property@SubstreamInfo:subdevice-id]. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_SUBNAME] = g_param_spec_string("subdevice-name", "subdevice-name", - "The name of subdevice for the direction and the " - "subdevice-id", + "The name of subdevice for the direction and the subdevice-id", "", G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:subdevice-count: + * + * The number of subdevices on the rawmidi device for the direction. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_SUBDEVICES_COUNT] = g_param_spec_uint("subdevices-count", "subdevices-count", "The number of subdevices on the rawmidi device for " @@ -145,6 +188,11 @@ static void alsarawmidi_substream_info_class_init(ALSARawmidiSubstreamInfoClass 0, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamInfo:subdevices-avail: + * + * The current number of available subdevices on the rawmidi device for the direction. + */ rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_SUBDEVICES_AVAIL] = g_param_spec_uint("subdevices-avail", "subdevices-avail", "The current number of available subdevices on the " From dfa9cb7918bc42b190b4c1dc3d15a0ac1c87c08a Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 06/23] rawmidi: substream-params: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/rawmidi/substream-params.c | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/src/rawmidi/substream-params.c b/src/rawmidi/substream-params.c index f9f4d2b8..2cc02f6e 100644 --- a/src/rawmidi/substream-params.c +++ b/src/rawmidi/substream-params.c @@ -80,6 +80,11 @@ static void alsarawmidi_substream_params_class_init(ALSARawmidiSubstreamParamsCl gobject_class->set_property = rawmidi_substream_params_set_property; gobject_class->get_property = rawmidi_substream_params_get_property; + /** + * ALSARawmidiSubstreamParams:buffer-size: + * + * The size of intermediate buffer for substream. + */ rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_BUFFER_SIZE] = g_param_spec_uint("buffer-size", "buffer-size", "The size of intermediate buffer for substream.", @@ -87,18 +92,27 @@ static void alsarawmidi_substream_params_class_init(ALSARawmidiSubstreamParamsCl page_size, G_PARAM_READWRITE); + /** + * ALSARawmidiSubstreamParams:avail-min: + * + * The threshold to wake up from any blocking operation such as poll(2), read(2) and write(2). + */ rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_AVAIL_MIN] = g_param_spec_uint("avail-min", "avail-min", - "The threshold to wake up from any blocking " - "operation such as poll(2), read(2) and write(2).", + "The threshold to wake up from any blocking operation such as poll(2), " + "read(2) and write(2).", 1, G_MAXUINT, 1, G_PARAM_READWRITE); + /** + * ALSARawmidiSubstreamParams:active-sensing: + * + * Whether to emit 0xfe one time when closing substream. + */ rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_ACTIVE_SENSING] = g_param_spec_boolean("active-sensing", "active-sensing", - "Whether to emit 0xfe one time when closing " - "substream.", + "Whether to emit 0xfe one time when closing substream.", FALSE, G_PARAM_READWRITE); From ea2c03418066284ea92f3bb75c9b010bfc79f633 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 07/23] rawmidi: substream-status: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/rawmidi/substream-status.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/rawmidi/substream-status.c b/src/rawmidi/substream-status.c index be58cd84..dc073af4 100644 --- a/src/rawmidi/substream-status.c +++ b/src/rawmidi/substream-status.c @@ -49,6 +49,11 @@ static void alsarawmidi_substream_status_class_init(ALSARawmidiSubstreamStatusCl gobject_class->get_property = rawmidi_substream_status_get_property; + /** + * ALSARawmidiSubstreamStatus:avail: + * + * The size of available space in intermediate buffer. + */ rawmidi_substream_status_props[RAWMIDI_SUBSTREAM_STATUS_PROP_AVAIL] = g_param_spec_uint64("avail", "avail", "The size of available space in intermediate buffer.", @@ -56,6 +61,11 @@ static void alsarawmidi_substream_status_class_init(ALSARawmidiSubstreamStatusCl 0, G_PARAM_READABLE); + /** + * ALSARawmidiSubstreamStatus:xruns: + * + * The count of XRUNs since the last query of status. + */ rawmidi_substream_status_props[RAWMIDI_SUBSTREAM_STATUS_PROP_XRUN] = g_param_spec_uint64("xruns", "xruns", "The count of XRUNs since the last query of status.", From 9dd5f101c24a0299cce9bb7c175e2ac1fe5d766a Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 08/23] hwdep: device-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/hwdep/device-info.c | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/src/hwdep/device-info.c b/src/hwdep/device-info.c index c2924880..e4178a68 100644 --- a/src/hwdep/device-info.c +++ b/src/hwdep/device-info.c @@ -88,36 +88,60 @@ static void alsahwdep_device_info_class_init(ALSAHwdepDeviceInfoClass *klass) gobject_class->set_property = hwdep_device_info_set_property; gobject_class->get_property = hwdep_device_info_get_property; + /** + * ALSAHwdepDeviceInfo:device-id: + * + * The numeric ID of device. + */ hwdep_device_info_props[HWDEP_DEVICE_INFO_PROP_DEVICE_ID] = g_param_spec_uint("device-id", "device-id", - "The numerical ID of device.", + "The numeric ID of device.", 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY); + /** + * ALSAHwdepDeviceInfo:card-id: + * + * The numeric ID of sound card. + */ hwdep_device_info_props[HWDEP_DEVICE_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card.", + "The numeric ID of sound card.", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY); + /** + * ALSAHwdepDeviceInfo:id: + * + * The string ID of the hwdep device. + */ hwdep_device_info_props[HWDEP_DEVICE_INFO_PROP_ID] = g_param_spec_string("id", "id", - "The ID string of the hwdep device", + "The string ID of the hwdep device", "", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY); + /** + * ALSAHwdepDeviceInfo:name: + * + * The name of the hwdep device. + */ hwdep_device_info_props[HWDEP_DEVICE_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of the hwdep device", "", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY); + /** + * ALSAHwdepDeviceInfo:iface: + * + * The type of interface for the hwdep device, one of ALSAHwdepIfaceType. + */ hwdep_device_info_props[HWDEP_DEVICE_INFO_PROP_IFACE] = g_param_spec_enum("iface", "iface", - "The type of interface for the hwdep device, one of " - "ALSAHwdepIfaceType.", + "The type of interface for the hwdep device, one of ALSAHwdepIfaceType.", ALSAHWDEP_TYPE_IFACE_TYPE, SNDRV_HWDEP_IFACE_OPL2, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY); From 761119fea44d3b1772098cf9f2bac86c1d38f630 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 09/23] timer: device-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/device-info.c | 46 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/src/timer/device-info.c b/src/timer/device-info.c index acb88db7..f40c0bb2 100644 --- a/src/timer/device-info.c +++ b/src/timer/device-info.c @@ -73,6 +73,11 @@ static void alsatimer_device_info_class_init(ALSATimerDeviceInfoClass *klass) gobject_class->get_property = timer_device_info_get_property; + /** + * ALSATimerDeviceInfo:flags: + * + * The flags of timer, one of [flags@DeviceInfoFlag]. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_FLAGS] = g_param_spec_flags("flags", "flags", "The flags of timer, one of ALSATimerDeviceInfoFlag.", @@ -80,25 +85,45 @@ static void alsatimer_device_info_class_init(ALSATimerDeviceInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:card-id: + * + * The numeric ID of sound card. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card.", + "The numeric ID of sound card.", G_MININT, G_MAXINT, -1, G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:id: + * + * The string ID of timer. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_ID] = g_param_spec_string("id", "id", "The string ID of timer.", "", G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:name: + * + * The name of timer. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of timer.", "", G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:resolution: + * + * The resolution in nano seconds. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_RESOLUTION] = g_param_spec_uint64("resolution", "resolution", "The resolution in nano seconds.", @@ -106,20 +131,35 @@ static void alsatimer_device_info_class_init(ALSATimerDeviceInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:resolution-min: + * + * The minimum resolution in nano seconds. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_RESOLUTION_MIN] = g_param_spec_uint64("resolution-min", "resolution-min", - "The resolution in nano seconds.", + "The minimum resolution in nano seconds.", 0, G_MAXUINT64, 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:resolution-max: + * + * The maximum resolution in nano seconds. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_RESOLUTION_MAX] = g_param_spec_uint64("resolution-max", "resolution-max", - "The resolution in nano seconds.", + "The maximum resolution in nano seconds.", 0, G_MAXUINT64, 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceInfo:instance-count: + * + * The number of instances for the timer. + */ timer_device_info_props[TIMER_DEVICE_INFO_PROP_INSTANCE_COUNT] = g_param_spec_uint("instance-count", "instance-count", "The number of instances for the timer.", From d0774d1eddd241fb8a6b915705efe5864b4aca23 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 10/23] timer: device-params: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/device-params.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/timer/device-params.c b/src/timer/device-params.c index c6480c17..0840be35 100644 --- a/src/timer/device-params.c +++ b/src/timer/device-params.c @@ -69,6 +69,11 @@ static void alsatimer_device_params_class_init(ALSATimerDeviceParamsClass *klass gobject_class->set_property = timer_device_params_set_property; gobject_class->get_property = timer_device_params_get_property; + /** + * ALSATimerDeviceParams:period-numerator: + * + * The numerator of period for timer. + */ timer_device_params_props[TIMER_DEVICE_PARAMS_PROP_PERIOD_NUM] = g_param_spec_uint64("period-numerator", "period-numerator", "The numerator of period for timer.", @@ -76,6 +81,11 @@ static void alsatimer_device_params_class_init(ALSATimerDeviceParamsClass *klass 0, G_PARAM_READWRITE); + /** + * ALSATimerDeviceParams:period-denominator: + * + * The denominator of period for timer. + */ timer_device_params_props[TIMER_DEVICE_PARAMS_PROP_PERIOD_DEN] = g_param_spec_uint64("period-denominator", "period-denominator", "The denominator of period for timer.", From 03adbf16d9fd8a0d11fad6960c9424a29ee97a58 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 11/23] timer: device-status: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/device-status.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/timer/device-status.c b/src/timer/device-status.c index bab91f4e..38900c13 100644 --- a/src/timer/device-status.c +++ b/src/timer/device-status.c @@ -53,6 +53,11 @@ static void alsatimer_device_status_class_init(ALSATimerDeviceStatusClass *klass gobject_class->get_property = timer_device_status_get_property; + /** + * ALSATimerDeviceStatus:resolution: + * + * The current resolution in nano seconds. + */ timer_device_status_props[TIMER_DEVICE_STATUS_PROP_RESOLUTION] = g_param_spec_uint64("resolution", "resolution", "The current resolution in nano seconds.", @@ -60,6 +65,11 @@ static void alsatimer_device_status_class_init(ALSATimerDeviceStatusClass *klass 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceStatus:resolution-numerator: + * + * The numerator of current resolution in seconds. + */ timer_device_status_props[TIMER_DEVICE_STATUS_PROP_RESOLUTION_NUM] = g_param_spec_uint64("resolution-numerator", "resolution-numerator", "The numerator of current resolution in seconds.", @@ -67,6 +77,11 @@ static void alsatimer_device_status_class_init(ALSATimerDeviceStatusClass *klass 0, G_PARAM_READABLE); + /** + * ALSATimerDeviceStatus:resolution-denominator: + * + * The denominator of current resolution in seconds. + */ timer_device_status_props[TIMER_DEVICE_STATUS_PROP_RESOLUTION_DEN] = g_param_spec_uint64("resolution-denominator", "resolution-denominator", "The denominator of current resolution in seconds.", From c901728c7f672089903fb695ac03ad43d090f554 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 12/23] timer: instance-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/instance-info.c | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/src/timer/instance-info.c b/src/timer/instance-info.c index c35f87e3..6b9756cc 100644 --- a/src/timer/instance-info.c +++ b/src/timer/instance-info.c @@ -61,6 +61,11 @@ static void alsatimer_instance_info_class_init(ALSATimerInstanceInfoClass *klass gobject_class->get_property = timer_instance_info_get_property; + /** + * ALSATimerInstanceInfo:flags: + * + * The flags for attached timer. + */ timer_instance_info_props[TIMER_INSTANCE_INFO_PROP_FLAGS] = g_param_spec_flags("flags", "flags", "The flags for attached timer.", @@ -68,25 +73,45 @@ static void alsatimer_instance_info_class_init(ALSATimerInstanceInfoClass *klass 0, G_PARAM_READABLE); + /** + * ALSATimerInstanceInfo:card-id: + * + * The numeric ID of sound card for attached timer. + */ timer_instance_info_props[TIMER_INSTANCE_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card for attached timer.", + "The numeric ID of sound card for attached timer.", G_MININT, G_MAXINT, -1, G_PARAM_READABLE); + /** + * ALSATimerInstanceInfo:id: + * + * The string ID of attached timer. + */ timer_instance_info_props[TIMER_INSTANCE_INFO_PROP_ID] = g_param_spec_string("id", "id", "The string ID of attached timer.", "", G_PARAM_READABLE); + /** + * ALSATimerInstanceInfo:name: + * + * The name of attached timer. + */ timer_instance_info_props[TIMER_INSTANCE_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of attached timer.", "", G_PARAM_READABLE); + /** + * ALSATimerInstanceInfo:resolution: + * + * The resolution of attached timer in nano seconds. + */ timer_instance_info_props[TIMER_INSTANCE_INFO_PROP_RESOLUTION] = g_param_spec_uint64("resolution", "resolution", "The resolution of attached timer in nano seconds.", From 8913b4e4a921e1eba275f7cb9943761c7c699157 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 13/23] timer: instance-params: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/instance-params.c | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/src/timer/instance-params.c b/src/timer/instance-params.c index d38ae5a5..c6fbe7c7 100644 --- a/src/timer/instance-params.c +++ b/src/timer/instance-params.c @@ -79,14 +79,23 @@ static void alsatimer_instance_params_class_init(ALSATimerInstanceParamsClass *k gobject_class->set_property = timer_instance_params_set_property; gobject_class->get_property = timer_instance_params_get_property; + /** + * ALSATimerInstanceParams:flags: + * + * The flags for user instance, as a set of [flags@InstanceParamFlag]. + */ timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_FLAGS] = g_param_spec_flags("flags", "flags", - "The flags for user instance, as a set of " - "ALSATimerInstanceParamFlag", + "The flags for user instance, as a set of ALSATimerInstanceParamFlag", ALSATIMER_TYPE_INSTANCE_PARAM_FLAG, 0, G_PARAM_READWRITE); + /** + * ALSATimerInstanceParams:interval: + * + * The interval to generate event in tick count. + */ timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_INTERVAL] = g_param_spec_uint("interval", "interval", "The interval to generate event in tick count.", @@ -94,6 +103,11 @@ static void alsatimer_instance_params_class_init(ALSATimerInstanceParamsClass *k 0, G_PARAM_READWRITE); + /** + * ALSATimerInstanceParams:queue-size: + * + * The size of queue. + */ timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_QUEUE_SIZE] = g_param_spec_uint("queue-size", "queue-size", "The size of queue.", From db72ff1d6f41b1e3bfb7e24fad5ced9a7db4c1d2 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 14/23] timer: instance-status: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/timer/instance-status.c | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/timer/instance-status.c b/src/timer/instance-status.c index d35bc6b6..75e4dd95 100644 --- a/src/timer/instance-status.c +++ b/src/timer/instance-status.c @@ -58,6 +58,11 @@ static void alsatimer_instance_status_class_init(ALSATimerInstanceStatusClass *k gobject_class->get_property = timer_instance_status_get_property; + /** + * ALSATimerInstanceStatus:interval: + * + * The current interval in nano second. + */ timer_instance_status_props[TIMER_INSTANCE_STATUS_PROP_INTERVAL] = g_param_spec_uint("interval", "interval", "The current interval in nano second.", @@ -65,6 +70,11 @@ static void alsatimer_instance_status_class_init(ALSATimerInstanceStatusClass *k 0, G_PARAM_READABLE); + /** + * ALSATimerInstanceStatus:lost: + * + * The count of losts master ticks. + */ timer_instance_status_props[TIMER_INSTANCE_STATUS_PROP_LOST] = g_param_spec_uint("lost", "lost", "The count of losts master ticks.", @@ -72,6 +82,11 @@ static void alsatimer_instance_status_class_init(ALSATimerInstanceStatusClass *k 0, G_PARAM_READABLE); + /** + * ALSATimerInstanceStatus:overrun: + * + * The count of overrun in read queue. + */ timer_instance_status_props[TIMER_INSTANCE_STATUS_PROP_OVERRUN] = g_param_spec_uint("overrun", "overrun", "The count of overrun in read queue.", @@ -79,6 +94,11 @@ static void alsatimer_instance_status_class_init(ALSATimerInstanceStatusClass *k 0, G_PARAM_READABLE); + /** + * ALSATimerInstanceStatus:queue-size: + * + * The current size of queue. + */ timer_instance_status_props[TIMER_INSTANCE_STATUS_PROP_QUEUE_SIZE] = g_param_spec_uint("queue-size", "queue-size", "The current size of queue.", From 0b9c351feb58697e1aa07fae071ee3aa72e78dd5 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 15/23] seq: fix description of object properties in which enumerations are available Signed-off-by: Takashi Sakamoto --- src/seq/query.c | 4 ++-- src/seq/queue-info.c | 8 ++++---- src/seq/queue-status.c | 4 ++-- src/seq/queue-tempo.c | 4 ++-- src/seq/queue-timer-common.c | 2 +- src/seq/remove-filter.c | 19 +++++++++---------- src/seq/user-client.c | 14 +++++++------- 7 files changed, 27 insertions(+), 28 deletions(-) diff --git a/src/seq/query.c b/src/seq/query.c index c7d451ef..bdd25491 100644 --- a/src/seq/query.c +++ b/src/seq/query.c @@ -587,7 +587,7 @@ gboolean alsaseq_get_queue_id_list(guint8 **entries, gsize *entry_count, GError /** * alsaseq_get_queue_info_by_id: - * @queue_id: The numeric ID of queue, except for one of [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. One of [enum@SpecificQueueId] is available as well. * @queue_info: (out): The information of queue. * @error: A [struct@GLib.Error]. Error is generated with domain of `GLib.FileError`. * @@ -673,7 +673,7 @@ gboolean alsaseq_get_queue_info_by_name(const gchar *name, ALSASeqQueueInfo **qu /** * alsaseq_get_queue_status: - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. One of [enum@SpecificQueueId] is available as well. * @queue_status: (inout): The current status of queue. * @error: A [struct@GLib.Error]. Error is generated with domain of `GLib.FileError`. * diff --git a/src/seq/queue-info.c b/src/seq/queue-info.c index f73fc2ca..f7b7c958 100644 --- a/src/seq/queue-info.c +++ b/src/seq/queue-info.c @@ -87,16 +87,16 @@ static void alsaseq_queue_info_class_init(ALSASeqQueueInfoClass *klass) seq_queue_info_props[SEQ_QUEUE_INFO_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", - "The numerical ID of queue, except for one of " - "ALSASeqSpecificClientId.", + "The numeric ID of queue. An entry of ALSASeqSpecificQueueId is " + "available as well", 0, G_MAXUINT8, 0, G_PARAM_READWRITE); seq_queue_info_props[SEQ_QUEUE_INFO_PROP_CLIENT_ID] = g_param_spec_uchar("client-id", "client-id", - "The numerical ID of client which owns the queue, " - "except for one of ALSASeqSpecificClientId.", + "The numeric ID of client which owns the queue. An entry of " + "ALSASeqSpecificClientId is available as well" 0, G_MAXUINT8, 0, G_PARAM_READWRITE); diff --git a/src/seq/queue-status.c b/src/seq/queue-status.c index 136d2869..de394c93 100644 --- a/src/seq/queue-status.c +++ b/src/seq/queue-status.c @@ -54,8 +54,8 @@ static void alsaseq_queue_status_class_init(ALSASeqQueueStatusClass *klass) seq_queue_status_props[SEQ_QUEUE_STATUS_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", - "The numerical ID of queue, except for entries in " - "ALSASeqSpecificQueueId.", + "The numeric ID of queue. An entry of ALSASeqSpecificQueueId is " + "available as well", 0, G_MAXUINT8, 0, G_PARAM_READABLE); diff --git a/src/seq/queue-tempo.c b/src/seq/queue-tempo.c index 45d42ffd..3d8132c5 100644 --- a/src/seq/queue-tempo.c +++ b/src/seq/queue-tempo.c @@ -77,8 +77,8 @@ static void alsaseq_queue_tempo_class_init(ALSASeqQueueTempoClass *klass) seq_queue_tempo_props[SEQ_QUEUE_TEMPO_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", - "The numerical ID of queue, except for one of " - "ALSASeqSpecificClientId.", + "The numeric ID of queue. An entry of ALSASeqSpecificClientId is " + "available as well", 0, G_MAXUINT8, 0, G_PARAM_READWRITE); diff --git a/src/seq/queue-timer-common.c b/src/seq/queue-timer-common.c index e21734b4..5519fdb5 100644 --- a/src/seq/queue-timer-common.c +++ b/src/seq/queue-timer-common.c @@ -21,7 +21,7 @@ static void alsaseq_queue_timer_common_default_init(ALSASeqQueueTimerCommonInter /** * ALSASeqQueueTimerCommon:queue-id: * - * The numeric identifier of queue, including one of [enum@SpecificClientId]. + * The numeric identifier of queue. An entry of [enum@SpecificClientId] is available as well. * * Since: 0.3. */ diff --git a/src/seq/remove-filter.c b/src/seq/remove-filter.c index 42b16157..bd146f59 100644 --- a/src/seq/remove-filter.c +++ b/src/seq/remove-filter.c @@ -32,7 +32,7 @@ G_DEFINE_BOXED_TYPE(ALSASeqRemoveFilter, alsaseq_remove_filter, seq_remove_filte * alsaseq_remove_filter_new_with_dest_addr: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @dest: The address of destination. * * Allocate and return a memory object of [struct@RemoveFilter] to remove queued events towards the @@ -59,7 +59,7 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_dest_addr( * alsaseq_remove_filter_new_with_note_channel: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @channel: The channel for note event. * * Allocate and return a memory object of [struct@RemoveFilter] to remove queued events with note @@ -86,7 +86,7 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_note_channel( * alsaseq_remove_filter_new_with_event_type: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @ev_type: The type of event. * * Allocate and return a memory object of [struct@RemoveFilter] to remove queued events with the @@ -111,12 +111,11 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_event_type( /** * alsaseq_remove_filter_new_with_note: - * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or - * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or [flags@RemoveFilterFlag].OUTPUT. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * * Allocate and return a memory object of [struct@RemoveFilter] to remove queued events for note, - * except for [enum@EventType:NOTEOFF]. + * excluding [enum@EventType:NOTEOFF]. * * Returns: A [struct@RemoveFilter]. */ @@ -137,7 +136,7 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_note( * alsaseq_remove_filter_new_with_tag: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @tag: The tag of event to remove. * * Allocate and return a memory object of [struct@RemoveFilter] to remove queued events with the @@ -164,7 +163,7 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_tag( * alsaseq_remove_filter_new_with_tick_time: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @tick_time: The count of tick. * @after: Remove events after the tick time if true, else remove events before the tick time. * @@ -196,7 +195,7 @@ ALSASeqRemoveFilter *alsaseq_remove_filter_new_with_tick_time( * alsaseq_remove_filter_new_with_real_time: * @inout: The direction of queue; [flags@RemoveFilterFlag].INPUT or * [flags@RemoveFilterFlag].OUTPUT. - * @queue_id: The numeric identifier of queue. + * @queue_id: The numeric ID of queue, excluding [enum@SpecificQueueId].DIRECT. * @tv_sec: The second part of time. * @tv_nsec: The nanosecond part of time. * @after: Remove events after the real time if true, else remove events before the real time. diff --git a/src/seq/user-client.c b/src/seq/user-client.c index 8b6fb88d..e8e997fc 100644 --- a/src/seq/user-client.c +++ b/src/seq/user-client.c @@ -876,7 +876,7 @@ gboolean alsaseq_user_client_create_queue(ALSASeqUserClient *self, /** * alsaseq_user_client_delete_queue: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for one of [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * * Delete the queue owned by the client. @@ -947,7 +947,7 @@ gboolean alsaseq_user_client_update_queue(ALSASeqUserClient *self, ALSASeqQueueI /** * alsaseq_user_client_get_queue_usage: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @use: (out): Whether the client uses the queue or not. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * @@ -983,7 +983,7 @@ gboolean alsaseq_user_client_get_queue_usage(ALSASeqUserClient *self, guint8 que /** * alsaseq_user_client_set_queue_usage: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @use: Whether to use the queue or not. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * @@ -1020,7 +1020,7 @@ gboolean alsaseq_user_client_set_queue_usage(ALSASeqUserClient *self, guint8 que /** * alsaseq_user_client_set_queue_tempo: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @queue_tempo: The data of tempo for queue. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * @@ -1059,7 +1059,7 @@ gboolean alsaseq_user_client_set_queue_tempo(ALSASeqUserClient *self, guint8 que /** * alsaseq_user_client_get_queue_tempo: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @queue_tempo: (out): The data of tempo for queue. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * @@ -1098,7 +1098,7 @@ gboolean alsaseq_user_client_get_queue_tempo(ALSASeqUserClient *self, guint8 que /** * alsaseq_user_client_set_queue_timer: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @queue_timer: The data of timer for queue, which implements [iface@QueueTimerCommon]. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * @@ -1150,7 +1150,7 @@ gboolean alsaseq_user_client_set_queue_timer(ALSASeqUserClient *self, guint8 que /** * alsaseq_user_client_get_queue_timer: * @self: A [class@UserClient]. - * @queue_id: The numeric ID of queue, except for entries in [enum@SpecificQueueId]. + * @queue_id: The numeric ID of queue. An entry of [enum@SpecificQueueId] is available as well. * @queue_timer: (out): The data of timer for queue, which implements [iface@QueueTimerCommon]. * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSASeq.UserClientError`. * From 0692faf2aba34e1cd23a8c7f766e0fac3c3d1ed5 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 16/23] seq: client-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/client-info.c | 59 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 52 insertions(+), 7 deletions(-) diff --git a/src/seq/client-info.c b/src/seq/client-info.c index 40d5402a..1a19ac0f 100644 --- a/src/seq/client-info.c +++ b/src/seq/client-info.c @@ -120,15 +120,25 @@ static void alsaseq_client_info_class_init(ALSASeqClientInfoClass *klass) gobject_class->set_property = seq_client_info_set_property; gobject_class->get_property = seq_client_info_get_property; + /** + * ALSASeqClientInfo:client-id: + * + * The numeric ID of client. One of [enum@SpecificClientId] is available as well as any + * numeric value. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_CLIENT_ID] = g_param_spec_uchar("client-id", "client-id", - "The numerical ID of client. One of " - "ALSASeqSpecificClientId is available as well as " - "any numerical value.", + "The numeric ID of client. One of ALSASeqSpecificClientId is " + "available as well as any numeric value.", 0, G_MAXUINT8, 0, G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:type: + * + * The type of client, one of [enum@ClientType]. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_CLIENT_TYPE] = g_param_spec_enum("type", "type", "The type of client, one of ALSASeqClientType.", @@ -136,12 +146,22 @@ static void alsaseq_client_info_class_init(ALSASeqClientInfoClass *klass) ALSASEQ_CLIENT_TYPE_NONE, G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:name: + * + * The name of client. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of client.", "", G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:filter-attributes: + * + * The attributes for event filter. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_FILTER_ATTR_FLAGS] = g_param_spec_flags("filter-attributes", "filter-attributes", "The attributes for event filter.", @@ -149,12 +169,22 @@ static void alsaseq_client_info_class_init(ALSASeqClientInfoClass *klass) 0, G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:use-filter: + * + * Whether using filter to receive event or not. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_USE_FILTER] = g_param_spec_boolean("use-filter", "use-filter", "Whether using filter to receive event or not.", FALSE, G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:port-count: + * + * The number of ports opened by the client. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_PORT_COUNT] = g_param_spec_int("port-count", "port-count", "The number of ports opened by the client.", @@ -162,6 +192,11 @@ static void alsaseq_client_info_class_init(ALSASeqClientInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqClientInfo:lost-count: + * + * The number of lost events. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_LOST_COUNT] = g_param_spec_int("lost-count", "lost-count", "The number of lost events.", @@ -169,18 +204,28 @@ static void alsaseq_client_info_class_init(ALSASeqClientInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqClientInfo:card-id: + * + * The numeric ID of sound card. Available in Linux kernel 4.6.0 or later. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card. " - "Available in Linux kernel 4.6.0 or later.", + "The numeric ID of sound card. Available in Linux kernel 4.6.0 or " + "later.", G_MININT, G_MAXINT, -1, G_PARAM_READWRITE); + /** + * ALSASeqClientInfo:process-id: + * + * The process ID for user client, otherwise -1. Available in Linux kernel 4.6.0 or later. + */ seq_client_info_props[SEQ_CLIENT_INFO_PROP_PROCESS_ID] = g_param_spec_int64("process-id", "process-id", - "The process ID for user client, otherwise -1. " - "Available in Linux kernel 4.6.0 or later", + "The process ID for user client, otherwise -1. Available in Linux " + "kernel 4.6.0 or later", G_MININT64, G_MAXINT64, -1, G_PARAM_READABLE); From 1c558b9093ef7a7a3f2577ca643a900fe606372b Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 17/23] seq: client-pool: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/client-pool.c | 52 ++++++++++++++++++++++++++++++++----------- 1 file changed, 39 insertions(+), 13 deletions(-) diff --git a/src/seq/client-pool.c b/src/seq/client-pool.c index bd745e31..789b5e9c 100644 --- a/src/seq/client-pool.c +++ b/src/seq/client-pool.c @@ -96,51 +96,77 @@ static void alsaseq_client_pool_class_init(ALSASeqClientPoolClass *klass) gobject_class->set_property = seq_client_pool_set_property; gobject_class->get_property = seq_client_pool_get_property; + /** + * ALSASeqClientPool:client-id: + * + * The numeric ID of client. One of [enum@SpecificClientId] is available as well as any + * numeric value. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_CLIENT_ID] = g_param_spec_uchar("client-id", "client-id", - "The numerical ID of client. One of " - "ALSASeqSpecificClientId is available as well as " - "any numerical value.", + "The numeric ID of client. One of ALSASeqSpecificClientId is available " + "as well as any numeric value.", 0, G_MAXUINT8, 0, G_PARAM_READABLE); + /** + * ALSASeqClientPool:output-pool: + * + * The total number of cells in memory pool for output direction. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_OUTPUT_POOL] = g_param_spec_int("output-pool", "output-pool", - "The total number of cells in memory pool for output " - "direction.", + "The total number of cells in memory pool for output direction.", 0, G_MAXINT, 0, G_PARAM_READWRITE); + /** + * ALSASeqClientPool:input-pool: + * + * The total number of cells in memory pool for input direction. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_INPUT_POOL] = g_param_spec_int("input-pool", "input-pool", - "The total number of cells in memory pool for input " - "direction.", + "The total number of cells in memory pool for input direction.", 0, G_MAXINT, 0, G_PARAM_READWRITE); + /** + * ALSASeqClientPool:output-room: + * + * The number of cells in memory pool for output direction to block user process. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_OUTPUT_ROOM] = g_param_spec_int("output-room", "output-room", - "The number of cells in memory pool for output " - "direction to block user process.", + "The number of cells in memory pool for output direction to block user " + "process", 0, G_MAXINT, 0, G_PARAM_READWRITE); + /** + * ALSASeqClientPool:output-free: + * + * The free number of cells in memory pool for output direction. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_OUTPUT_FREE] = g_param_spec_int("output-free", "output-free", - "The free number of cells in memory pool for output " - "direction.", + "The free number of cells in memory pool for output direction.", 0, G_MAXINT, 0, G_PARAM_READWRITE); + /** + * ALSASeqClientPool:input-free: + * + * The free number of cells in memory pool for input direction. + */ seq_client_pool_props[SEQ_CLIENT_POOL_PROP_INPUT_FREE] = g_param_spec_int("input-free", "input-free", - "The free number of cells in memory pool for input " - "direction.", + "The free number of cells in memory pool for input direction.", 0, G_MAXINT, 0, G_PARAM_READWRITE); From 0ed120af22e31fc4faa4a2426d22ff19c4a5ee39 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 18/23] seq: port-info: fix tag indentation Signed-off-by: Takashi Sakamoto --- src/seq/port-info.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/seq/port-info.c b/src/seq/port-info.c index fe6778b7..f375bd30 100644 --- a/src/seq/port-info.c +++ b/src/seq/port-info.c @@ -317,7 +317,7 @@ static void alsaseq_port_info_class_init(ALSASeqPortInfoClass *klass) g_param_spec_uchar("queue-id", "queue-id", "The numeric ID of queue to update time stamp when tstamp-overwrite " "property is set to True. One of ALSASeqSpecificQueueId is available " - "as well", + "as well", 0, G_MAXUINT8, 0, G_PARAM_READWRITE); From e85a16a11248707488f2cbffc1dc30617fb0ae83 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 19/23] seq: queue-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/queue-info.c | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/src/seq/queue-info.c b/src/seq/queue-info.c index f7b7c958..2d299b6a 100644 --- a/src/seq/queue-info.c +++ b/src/seq/queue-info.c @@ -85,6 +85,11 @@ static void alsaseq_queue_info_class_init(ALSASeqQueueInfoClass *klass) gobject_class->set_property = seq_queue_info_set_property; gobject_class->get_property = seq_queue_info_get_property; + /** + * ALSASeqQueueInfo:queue-id: + * + * The numeric ID of queue. An entry of ALSASeqSpecificQueueId is available as well. + */ seq_queue_info_props[SEQ_QUEUE_INFO_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", "The numeric ID of queue. An entry of ALSASeqSpecificQueueId is " @@ -93,20 +98,35 @@ static void alsaseq_queue_info_class_init(ALSASeqQueueInfoClass *klass) 0, G_PARAM_READWRITE); + /** + * ALSASeqQueueInfo:client-id: + * + * The numeric ID of client which owns the queue, including one of ALSASeqSpecificClientId. + */ seq_queue_info_props[SEQ_QUEUE_INFO_PROP_CLIENT_ID] = g_param_spec_uchar("client-id", "client-id", - "The numeric ID of client which owns the queue. An entry of " - "ALSASeqSpecificClientId is available as well" + "The numeric ID of client which owns the queue, including one of " + "ALSASeqSpecificClientId.", 0, G_MAXUINT8, 0, G_PARAM_READWRITE); + /** + * ALSASeqQueueInfo:locked: + * + * Whether to be locked by the other queues or not. + */ seq_queue_info_props[SEQ_QUEUE_INFO_PROP_LOCKED] = g_param_spec_boolean("locked", "locked", "Whether to be locked by the other queues or not.", FALSE, G_PARAM_READWRITE); + /** + * ALSASeqQueueInfo:name: + * + * The name of queue. + */ seq_queue_info_props[SEQ_QUEUE_INFO_PROP_NAME] = g_param_spec_string("name", "name", "The name of queue.", From c8be2170cc804feb2b7d6e9951077b8671a8748b Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 20/23] seq: queue-status: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/queue-status.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/seq/queue-status.c b/src/seq/queue-status.c index de394c93..a8375d12 100644 --- a/src/seq/queue-status.c +++ b/src/seq/queue-status.c @@ -52,6 +52,11 @@ static void alsaseq_queue_status_class_init(ALSASeqQueueStatusClass *klass) gobject_class->get_property = seq_queue_status_get_property; + /** + * ALSASeqQueueStatus:queue-id: + * + * The numeric ID of queue. An entry of ALSASeqSpecificQueueId is available as well. + */ seq_queue_status_props[SEQ_QUEUE_STATUS_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", "The numeric ID of queue. An entry of ALSASeqSpecificQueueId is " @@ -60,6 +65,11 @@ static void alsaseq_queue_status_class_init(ALSASeqQueueStatusClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqQueueStatus:event-count: + * + * The number of available events in the queue. + */ seq_queue_status_props[SEQ_QUEUE_STATUS_PROP_EVENT_COUNT] = g_param_spec_int("event-count", "event-count", "The number of available events in the queue.", @@ -67,6 +77,11 @@ static void alsaseq_queue_status_class_init(ALSASeqQueueStatusClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqQueueStatus:running: + * + * Whether the queue is running or not. + */ seq_queue_status_props[SEQ_QUEUE_STATUS_PROP_RUNNING] = g_param_spec_boolean("running", "running", "Whether the queue is running or not.", From a341199ad8ab107d4a8b71c80b95ffc8933244b7 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 21/23] seq: queue-tempo: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/queue-tempo.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/seq/queue-tempo.c b/src/seq/queue-tempo.c index 3d8132c5..12bd1edf 100644 --- a/src/seq/queue-tempo.c +++ b/src/seq/queue-tempo.c @@ -75,6 +75,11 @@ static void alsaseq_queue_tempo_class_init(ALSASeqQueueTempoClass *klass) gobject_class->set_property = seq_queue_tempo_set_property; gobject_class->get_property = seq_queue_tempo_get_property; + /** + * ALSASeqQueueTempo:queue-id: + * + * The numeric ID of queue. An entry of ALSASeqSpecificClientId is available as well, + */ seq_queue_tempo_props[SEQ_QUEUE_TEMPO_PROP_QUEUE_ID] = g_param_spec_uchar("queue-id", "queue-id", "The numeric ID of queue. An entry of ALSASeqSpecificClientId is " @@ -83,6 +88,11 @@ static void alsaseq_queue_tempo_class_init(ALSASeqQueueTempoClass *klass) 0, G_PARAM_READWRITE); + /** + * ALSASeqQueueTempo:tempo: + * + * The number of micro second per tick as tempo. + */ seq_queue_tempo_props[SEQ_QUEUE_TEMPO_PROP_TEMPO] = g_param_spec_uint("tempo", "tempo", "The number of micro second per tick as tempo.", @@ -90,6 +100,11 @@ static void alsaseq_queue_tempo_class_init(ALSASeqQueueTempoClass *klass) 0, G_PARAM_READWRITE); + /** + * ALSASeqQueueTempo:resolution: + * + * The number of pulse per quarter as resolution. + */ seq_queue_tempo_props[SEQ_QUEUE_TEMPO_PROP_RESOLUTION] = g_param_spec_int("resolution", "resolution", "The number of pulse per quarter as resolution.", From 3926e7228d43a0bba70f4755e834b6d1fa7b8654 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 22/23] seq: system-info: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/system-info.c | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/src/seq/system-info.c b/src/seq/system-info.c index ba544d08..1183dbb6 100644 --- a/src/seq/system-info.c +++ b/src/seq/system-info.c @@ -64,6 +64,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) gobject_class->get_property = seq_system_info_get_property; + /** + * ALSASeqSystemInfo:maximum-queue-count: + * + * The maximum number of available queues. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_MAXIMUM_QUEUE_COUNT] = g_param_spec_int("maximum-queue-count", "maximum-queue-count", "The maximum number of available queues.", @@ -71,6 +76,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqSystemInfo:maximum-client-count: + * + * The maximum number of clients. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_MAXIMUM_CLIENT_COUNT] = g_param_spec_int("maximum-client-count", "maximum-client-count", "The maximum number of clients.", @@ -78,6 +88,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqSystemInfo:maximum-port-count: + * + * The maximum number of ports. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_MAXIMUM_PORT_COUNT] = g_param_spec_int("maximum-port-count", "maximum-port-count", "The maximum number of ports.", @@ -85,6 +100,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqSystemInfo:maximum-channel-count: + * + * The maximum number of channels. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_MAXIMUM_CHANNEL_COUNT] = g_param_spec_int("maximum-channel-count", "maximum-channel-count", "The maximum number of channels.", @@ -92,6 +112,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqSystemInfo:current-client-count: + * + * The current number of clients. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_CURRENT_CLIENT_COUNT] = g_param_spec_int("current-client-count", "current-client-count", "The current number of clients.", @@ -99,6 +124,11 @@ static void alsaseq_system_info_class_init(ALSASeqSystemInfoClass *klass) 0, G_PARAM_READABLE); + /** + * ALSASeqSystemInfo:current-queue-count: + * + * The current number of queues. + */ seq_system_info_props[SEQ_SYSTEM_INFO_PROP_CURRENT_QUEUE_COUNT] = g_param_spec_int("current-queue-count", "current-queue-count", "The current number of queues.", From 7032e360e79a22fced0aef93a713dc5e8ff5a05f Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 20 Jun 2022 18:44:49 +0900 Subject: [PATCH 23/23] seq: user-client: add annotation to object properties Signed-off-by: Takashi Sakamoto --- src/seq/user-client.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/seq/user-client.c b/src/seq/user-client.c index e8e997fc..dd9293c2 100644 --- a/src/seq/user-client.c +++ b/src/seq/user-client.c @@ -111,6 +111,11 @@ static void alsaseq_user_client_class_init(ALSASeqUserClientClass *klass) gobject_class->finalize = seq_user_client_finalize; gobject_class->get_property = seq_user_client_get_property; + /** + * ALSASeqUserClient:client-id: + * + * The numeric ID of the client. + */ seq_user_client_props[SEQ_USER_CLIENT_PROP_CLIENT_ID] = g_param_spec_uchar("client-id", "client-id", "The numeric ID of the client.",