From fd28e750f8856f3c2dfd54e76c2e438417a06e9c Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] timer: event_data_tstamp: link optimization to gi-docgen The gi-docgen supports enhancement of inter-document link. This commit is optimization to it. Signed-off-by: Takashi Sakamoto --- src/timer/event-data-tstamp.c | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/src/timer/event-data-tstamp.c b/src/timer/event-data-tstamp.c index 2994044..493e3d2 100644 --- a/src/timer/event-data-tstamp.c +++ b/src/timer/event-data-tstamp.c @@ -2,15 +2,12 @@ #include "privates.h" /** - * SECTION: event-data-tstamp - * @Title: ALSATimerEventDataTstamp - * @Short_description: A boxed object to represent event of timer with - * tstamp + * ALSATimerEventDataTstamp: + * A boxed object to represent event of timer with tstamp. * - * A #ALSATimerEventDataTstamp is a boxed object to represent event of timer - * with tstamp. + * A [struct@EventDataTstamp] is a boxed object to represent event of timer with tstamp. * - * The object wraps 'struct snd_timer_tread' in UAPI of Linux sound subsystem. + * The object wraps `struct snd_timer_tread` in UAPI of Linux sound subsystem. */ ALSATimerEventDataTstamp *timer_event_data_tstamp_copy(const ALSATimerEventDataTstamp *self) { @@ -29,8 +26,8 @@ G_DEFINE_BOXED_TYPE(ALSATimerEventDataTstamp, alsatimer_event_data_tstamp, timer /** * alsatimer_event_data_tstamp_get_event: - * @self: A #ALSATimerEventDataTstamp. - * @event: (out): The type of tstamp event, one of ALSATimerEventType. + * @self: A [struct@EventDataTstamp]. + * @event: (out): The type of tstamp event, one of [enum@EventType]. * * Get the kind of event for the timestamp event. */ @@ -42,10 +39,9 @@ void alsatimer_event_data_tstamp_get_event(const ALSATimerEventDataTstamp *self, /** * alsatimer_event_data_tstamp_get_tstamp: - * @self: A #ALSATimerEventDataTstamp. - * @tstamp: (array fixed-size=2)(inout): The array with two elements for the - * seconds and nanoseconds part of timestamp when the instance queues - * the timestamp event. + * @self: A [struct@EventDataTstamp]. + * @tstamp: (array fixed-size=2)(inout): The array with two elements for the seconds and + * nanoseconds part of timestamp when the instance queues the timestamp event. * * Get the seconds and nanoseconds part for the timestamp event. */ @@ -58,7 +54,7 @@ void alsatimer_event_data_tstamp_get_tstamp(const ALSATimerEventDataTstamp *self /** * alsatimer_event_data_tstamp_get_val: - * @self: A #ALSATimerEventDataTstamp. + * @self: A [struct@EventDataTstamp]. * @val: (out): The value depending on the type of timestamp event. * * Get the value depending on the type of timestamp event. -- 2.47.3