]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: port_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/seq/port-info.c

index c1b11784665ec69a0655f5bacd16a74a377ca801..40d8f9e2894667d615ebd6e53263d80076e5549b 100644 (file)
@@ -2,16 +2,14 @@
 #include "privates.h"
 
 /**
- * SECTION: port-info
- * @Title: ALSASeqPortInfo
- * @Short_description: A GObject-derived object to represent information of port
+ * ALSASeqPortInfo:
+ * A GObject-derived object to represent information of port.
  *
- * A #ALSASeqPortInfo is a GObject-derived object to represent information of
- * port. The call of alsaseq_get_port_info() returns the instance of object.
- * The call of alsaseq_user_client_create_port() and
- * alsaseq_user_client_update_port() requires the instance of object.
+ * A [class@PortInfo] is a GObject-derived object to represent information of port. The call of
+ * [func@get_port_info] returns the instance of object. The call of [method@UserClient.create_port]
+ * and [method@UserClient.update_port] requires the instance of object.
  *
- * The object wraps 'struct snd_port_info' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_port_info` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_seq_port_info info;
@@ -253,7 +251,9 @@ static void alsaseq_port_info_init(ALSASeqPortInfo *self)
 /**
  * alsaseq_port_info_new:
  *
- * Allocate and return an instance of ALSASeqPortInfo class.
+ * Allocate and return an instance of [class@PortInfo].
+ *
+ * Returns: An instance of [class@PortInfo].
  */
 ALSASeqPortInfo *alsaseq_port_info_new()
 {