]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
ctl: card_info: link optimization to gi-docgen
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +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/ctl/card-info.c

index 80ccd71b8941fb17fdd3b6c275015985cedc9b0a..0cf9da21a2630e3cceca68e8af1092f1da83ddde 100644 (file)
@@ -2,16 +2,13 @@
 #include "privates.h"
 
 /**
- * SECTION: card-info
- * @Title: ALSACtlCardInfo
- * @Short_description: A GObject-derived object to represent information of
- *                     sound card
+ * ALSACtlCardInfo:
+ * A GObject-derived object to represent information of sound card.
  *
- * A #ALSACtlCardInfo is a GObject-derived object to represent information of
- * sound card. The call of alsactl_card_get_info() returns an instance of the
- * object.
+ * A [class@CardInfo] is information of sound card. The call of [method@Card.get_info] returns an
+ * instance of the object.
  *
- * The object wraps 'struct snd_ctl_card_info' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_ctl_card_info` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_ctl_card_info info;