From: Takashi Sakamoto Date: Mon, 20 Jun 2022 09:44:49 +0000 (+0900) Subject: seq: fix description of object properties in which enumerations are available X-Git-Tag: v0.3.0~47 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=9c2763fa39e5b2c0c47a4cc4ac3bb43b7119219a;p=alsa-gobject.git seq: fix description of object properties in which enumerations are available Signed-off-by: Takashi Sakamoto --- diff --git a/src/seq/query.c b/src/seq/query.c index c7d451e..bdd2549 100644 --- a/src/seq/query.c +++ b/src/seq/query.c @@ -587,7 +587,7 @@ end: /** * 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 f73fc2c..f7b7c95 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 136d286..de394c9 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 45d42ff..3d8132c 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 e21734b..5519fdb 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 42b1615..bd146f5 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 8b6fb88..e8e997f 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`. *