]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: queue-info: add annotation to object properties
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 09:44:49 +0000 (18:44 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 09:44:49 +0000 (18:44 +0900)
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/seq/queue-info.c

index f7b7c958f8f4de4304b7b83469349b02fd330f58..2d299b6a0b256b9aa14ec4439b05029dfe65561b 100644 (file)
@@ -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.",