doc: seq: add documentation for ALSASeqEventCntr

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 6e9ea9d5f15efa65332331d73191cd3cf27b9ca4..8eaf22185e52d49d260800770c9f577c884519a2 100644 (file)
--- a/doc/reference/seq/alsaseq-docs.xml
+++ b/doc/reference/seq/alsaseq-docs.xml
@@ -40,6 +40,7 @@
         <xi:include href="xml/addr.xml"/>
         <xi:include href="xml/port-info.xml"/>
         <xi:include href="xml/subscribe-data.xml"/>
+        <xi:include href="xml/event-cntr.xml"/>
         <xi:include href="xml/event.xml"/>
         <xi:include href="xml/event-fixed.xml"/>
         <xi:include href="xml/event-variable.xml"/>

diff --git a/doc/reference/seq/alsaseq.types b/doc/reference/seq/alsaseq.types
index b867cb1549bb06631d1421a8eb0faa982ecda3d3..03e29e9aed92fa5cfc51a7bc91915c296be93190 100644 (file)
--- a/doc/reference/seq/alsaseq.types
+++ b/doc/reference/seq/alsaseq.types
@@ -37,3 +37,4 @@ alsaseq_queue_status_get_type
 alsaseq_queue_tempo_get_type
 alsaseq_queue_timer_get_type
 alsaseq_queue_timer_alsa_get_type
+alsaseq_event_cntr_get_type

diff --git a/src/seq/event-cntr.c b/src/seq/event-cntr.c
index 0f8790ff118b1b07b976a1056dcae0ec2d4016af..9c5b0ea213833d27c786a24b3fefb4aab270ca1e 100644 (file)
--- a/src/seq/event-cntr.c
+++ b/src/seq/event-cntr.c
@@ -3,6 +3,46 @@
 
 #include <errno.h>
 
+/**
+ * SECTION: event-cntr
+ * @Title: ALSASeqEventCntr
+ * @Short_description: A GObject-derived object to represent container for a
+ *                     batch of events
+ *
+ * A #ALSASeqEventCntr is a GObject-derived object to represent container for
+ * a batch of events. The instance of object has accessor methods to properties
+ * and data for each events expanded to the flat memory space. The object is
+ * designed for applications to maintain collections of event by the convenient
+ * way which each programming language produces.
+ *
+ * This is the list of properties for event:
+ * - the type of event
+ * - the mode of time stamp
+ * - the mode of time
+ * - the mode of length
+ * - the mode of priority
+ * - associated tag
+ * - the numerical ID of associated queue
+ * - time stamp
+ * - destination address
+ * - source address
+ *
+ * This is the list of data for event. These data shared the same storage and
+ * an event can have the sole type of data:
+ * - note
+ * - control
+ * - 12 bytes
+ * - 3 quadlets
+ * - blob as variable length of bytes
+ * - queue control
+ * - arbitrary time stamp
+ * - arbitrary address
+ * - connection with source and destination addresses
+ * - result
+ *
+ * The data shares the same storage in event. An event can have the sole type
+ * of data. The type of data is not associated to the type of event directly.
+ */
 typedef struct _ALSASeqEventCntrPrivate {
     guint8 *buf;
     gsize length;