From f60d402d5444d7458055a1928dd2bca077cb709e Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Wed, 10 Jun 2020 12:57:49 +0900 Subject: [PATCH] timer: event: add documentation for ALSATimerEvent Signed-off-by: Takashi Sakamoto --- doc/reference/timer/alsatimer-docs.xml | 1 + doc/reference/timer/alsatimer.types | 1 + src/timer/event.c | 11 +++++++++++ 3 files changed, 13 insertions(+) diff --git a/doc/reference/timer/alsatimer-docs.xml b/doc/reference/timer/alsatimer-docs.xml index 07ed742..ec7922f 100644 --- a/doc/reference/timer/alsatimer-docs.xml +++ b/doc/reference/timer/alsatimer-docs.xml @@ -41,6 +41,7 @@ + diff --git a/doc/reference/timer/alsatimer.types b/doc/reference/timer/alsatimer.types index 4b64a1d..a1118ec 100644 --- 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 a25e7c7..ace1596 100644 --- 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)); -- 2.47.3