From 3f21db484aef1cb2065aaca53e6f69b8583c5ee5 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Mon, 8 Jun 2020 23:10:10 +0900 Subject: [PATCH] doc: seq: add documentation for ALSASeqEventCntr Signed-off-by: Takashi Sakamoto --- doc/reference/seq/alsaseq-docs.xml | 1 + doc/reference/seq/alsaseq.types | 1 + src/seq/event-cntr.c | 40 ++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+) diff --git a/doc/reference/seq/alsaseq-docs.xml b/doc/reference/seq/alsaseq-docs.xml index 6e9ea9d..8eaf221 100644 --- a/doc/reference/seq/alsaseq-docs.xml +++ b/doc/reference/seq/alsaseq-docs.xml @@ -40,6 +40,7 @@ + diff --git a/doc/reference/seq/alsaseq.types b/doc/reference/seq/alsaseq.types index b867cb1..03e29e9 100644 --- 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 0f8790f..9c5b0ea 100644 --- a/src/seq/event-cntr.c +++ b/src/seq/event-cntr.c @@ -3,6 +3,46 @@ #include +/** + * 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; -- 2.47.3