seq: queue_timer_data_alsa: add documentation

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

diff --git a/doc/reference/seq/alsaseq-docs.xml b/doc/reference/seq/alsaseq-docs.xml
index df38e5592aabe998c2b84eb54a682a687154a2c5..64e308bc5fa93dc10a653ae91c0b109bed596f6e 100644 (file)
--- a/doc/reference/seq/alsaseq-docs.xml
+++ b/doc/reference/seq/alsaseq-docs.xml
@@ -52,6 +52,7 @@
         <xi:include href="xml/queue-tempo.xml"/>
         <xi:include href="xml/queue-timer.xml"/>
         <xi:include href="xml/queue-timer-alsa.xml"/>
+        <xi:include href="xml/queue-timer-data-alsa.xml"/>
         <xi:include href="xml/remove-filter.xml"/>
     </chapter>
 

diff --git a/doc/reference/seq/alsaseq.types b/doc/reference/seq/alsaseq.types
index 5982da028178994e53bf764f2e52d036679b8b91..d8d91c1587ad5b3e6055938e8a4c3a9b1ca7baca 100644 (file)
--- a/doc/reference/seq/alsaseq.types
+++ b/doc/reference/seq/alsaseq.types
@@ -34,4 +34,5 @@ alsaseq_queue_status_get_type
 alsaseq_queue_tempo_get_type
 alsaseq_queue_timer_get_type
 alsaseq_queue_timer_alsa_get_type
+alsaseq_queue_timer_data_alsa_get_type
 alsaseq_event_cntr_get_type

diff --git a/src/seq/queue-timer-data-alsa.c b/src/seq/queue-timer-data-alsa.c
index 8c01d99d04d22f600bdb839cb6b5bd90807b237c..df4d64986a8df65eea39c453929041f55974bc3f 100644 (file)
--- a/src/seq/queue-timer-data-alsa.c
+++ b/src/seq/queue-timer-data-alsa.c
@@ -1,6 +1,16 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 #include "queue-timer-data-alsa.h"
 
+/**
+ * SECTION: queue-timer-data-alsa
+ * @Title: ALSASeqQueueTimerDataAlsa
+ * @Short_description: A boxed object to represent data of queue timer in the
+ *                     case of ALSATimer
+ *
+ * A #ALSASeqQueueTimerDataAlsa is a boxed object to represent data of queue
+ * timer in the case of ALSATimer. The instance of object is one of data
+ * properties in queue timer.
+ */
 ALSASeqQueueTimerDataAlsa *seq_queue_timer_data_alsa_copy(const ALSASeqQueueTimerDataAlsa *self)
 {
     return g_memdup(self, sizeof(*self));