]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: device_info: 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/device-info.c

index 83e5454118f6133e0f29b080d4ab15da985533fd..acb88db7fdc678717cbcd0000b816f86ea513be3 100644 (file)
@@ -2,16 +2,14 @@
 #include "privates.h"
 
 /**
- * SECTION: device-info
- * @Title: ALSATimerDeviceInfo
- * @Short_description: A GObject-derived object to represent information of
- *                     timer device.
+ * ALSATimerDeviceInfo:
+ * A GObject-derived object to represent information of timer device.
  *
- * A #ALSATimerDeviceInfo is a GObject-derived object to represent information
- * of timer device. The call of alsatimer_get_device_info() returns an instance
- * of the object according to the identifier of timer device.
+ * A [class@DeviceInfo] is a GObject-derived object to represent information of timer device.
+ * The call of alsatimer_get_device_info() returns an instance of the object according to the
+ * identifier of timer device.
  *
- * The object wraps 'struct snd_timer_ginfo' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_timer_ginfo` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_timer_ginfo info;