]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: event_data_tick: link optimization to gi-docgen
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Wed, 20 Apr 2022 00:51:44 +0000 (09:51 +0900)
The gi-docgen supports enhancement of inter-document link. This commit is
optimization to it.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/timer/event-data-tick.c

index dc4efe0b84c8607a36b5698bcff601d633e5d297..0bfaa8f4a9d9438987c91992fae4a14d779a0977 100644 (file)
@@ -2,15 +2,12 @@
 #include "privates.h"
 
 /**
- * SECTION: event-data-tick
- * @Title: ALSATimerEventDataTick
- * @Short_description: A boxed object to represent event of timer with tick
- *                     count
+ * ALSATimerEventDataTick:
+ * A boxed object to represent event of timer with tick count.
  *
- * A #ALSATimerEventDataTick is a boxed object to represent event of timer with
- * tick count.
+ * A [struct@EventDataTick] is a boxed object to represent event of timer with tick count.
  *
- * The object wraps 'struct snd_timer_read' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_timer_read` in UAPI of Linux sound subsystem.
  */
 ALSATimerEventDataTick *timer_event_data_tick_copy(const ALSATimerEventDataTick *self)
 {
@@ -29,7 +26,7 @@ G_DEFINE_BOXED_TYPE(ALSATimerEventDataTick, alsatimer_event_data_tick, timer_eve
 
 /**
  * alsatimer_event_data_tick_get_resolution:
- * @self: A #ALSATimerEventDataTick.
+ * @self: A [struct@EventDataTick].
  * @resolution: (out): The resolution of tick event.
  *
  * Get the resolution of tick event.
@@ -42,7 +39,7 @@ void alsatimer_event_data_tick_get_resolution(const ALSATimerEventDataTick *self
 
 /**
  * alsatimer_event_data_tick_get_ticks:
- * @self: A #ALSATimerEventDataTick.
+ * @self: A [struct@EventDataTick].
  * @ticks: (out): The tick count since the last event.
  *
  * Get the tick count since the last event.