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

index 5d8910369a2fe24c8f8fd2c03286af85de0ab1e7..bab91f4e785a61ddb7c0064a657096ce128896ec 100644 (file)
@@ -2,14 +2,11 @@
 #include "privates.h"
 
 /**
- * SECTION: device-status
- * @Title: ALSATimerDeviceStatus
- * @Short_description: A GObject-derived object to represent status of timer
- *                     device.
+ * ALSATimerDeviceStatus:
+ * A GObject-derived object to represent status of timer device.
  *
- * A #ALSATimerDeviceStatus is a GObject-derived object to represent status of
- * timer device. The call of alsatimer_get_device_status() returns the instance
- * of object.
+ * A [class@DeviceStatus] is a GObject-derived object to represent status of timer device. The
+ * call of [func@get_device_status] returns the instance of object.
  *
  * The object wraps 'struct snd_timer_gstatus' in UAPI of Linux sound subsystem.
  */
@@ -90,9 +87,9 @@ static void alsatimer_device_status_init(ALSATimerDeviceStatus *self)
 /**
  * alsatimer_device_status_new:
  *
- * Allocate and return an instance of #ALSATimerDeviceStatus.
+ * Allocate and return an instance of [class@DeviceStatus].
  *
- * Returns: A #ALSATimerDeviceStatus.
+ * Returns: An instance of [class@DeviceStatus].
  */
 ALSATimerDeviceStatus *alsatimer_device_status_new()
 {