timer: event: add documentation for ALSATimerEvent

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

diff --git a/doc/reference/timer/alsatimer-docs.xml b/doc/reference/timer/alsatimer-docs.xml
index 07ed742bbd82490209adee3fd799775722477a51..ec7922f64fb97779329278d482975bde3767618e 100644 (file)
--- a/doc/reference/timer/alsatimer-docs.xml
+++ b/doc/reference/timer/alsatimer-docs.xml
@@ -41,6 +41,7 @@
         <xi:include href="xml/instance-info.xml"/>
         <xi:include href="xml/instance-status.xml"/>
         <xi:include href="xml/instance-params.xml"/>
+        <xi:include href="xml/event.xml"/>
         <xi:include href="xml/event-data-tick.xml"/>
         <xi:include href="xml/event-data-tstamp.xml"/>
     </chapter>

diff --git a/doc/reference/timer/alsatimer.types b/doc/reference/timer/alsatimer.types
index 4b64a1d3624b8b1c9218b07eead2beb196209c98..a1118ec9b2b9706b46cc80bfcd240a15437a8f02 100644 (file)
--- a/doc/reference/timer/alsatimer.types
+++ b/doc/reference/timer/alsatimer.types
@@ -13,5 +13,6 @@ alsatimer_user_instance_get_type
 alsatimer_instance_info_get_type
 alsatimer_instance_params_get_type
 alsatimer_instance_status_get_type
+alsatimer_event_get_type
 alsatimer_event_data_tick_get_type
 alsatimer_event_data_tstamp_get_type

diff --git a/src/timer/event.c b/src/timer/event.c
index a25e7c7a12670efe6a0c8323a000f198079682c6..ace15960986af9db503cd0f109f0f81539b5b301 100644 (file)
--- a/src/timer/event.c
+++ b/src/timer/event.c
@@ -1,6 +1,17 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 #include "event.h"
 
+/**
+ * SECTION: event
+ * @Title: ALSATimerEvent
+ * @Short_description: A boxed object to represent event of timer
+ *
+ * A #ALSATimerEvent is a boxed object to represent event of timer. The
+ * instance of object uses single storage for two types of event data;
+ * #ALSATimerEventDataTick for and #ALSATimerEventDataTstamp. Applications can
+ * decide to use one of the two by passing one of #ALSATimerEventType to the
+ * call of alsatimer_user_instance_attach().
+ */
 ALSATimerEvent *timer_event_copy(const ALSATimerEvent *self)
 {
     return g_memdup(self, sizeof(*self));