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

index 0513799433993064352b3b18a9dc9cb88ddf9deb..c35f87e3781f5b6973272219682a8780c8d002d3 100644 (file)
@@ -2,16 +2,14 @@
 #include "privates.h"
 
 /**
- * SECTION: instance-info
- * @Title: ALSATimerInstanceInfo
- * @Short_description: A GObject-derived object to represent information of
- *                     user instance
+ * ALSATimerInstanceInfo:
+ * A GObject-derived object to represent information of user instance.
  *
- * A #ALSATimerInstanceInfo is a GObject-derived object to represent information
- * of user instance attached to any timer device or the other instance as slave.
- * The call of alsatimer_user_instance_get_info() returns the instance of object.
+ * A [class@InstanceInfo] is a GObject-derived object to represent information of user instance
+ * attached to any timer device or the other instance as slave. The call of
+ * [method@UserInstance.get_info] returns the instance of object.
  *
- * The object wraps 'struct snd_timer_info' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_timer_info` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_timer_info info;