]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: subscribe_data: 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/subscribe-data.c

index 531a87d863faa364509680d0ec3d5d9c1db0a21e..d1dea0e3ed2e5268f4b2cfe439082c57c915af00 100644 (file)
@@ -2,18 +2,14 @@
 #include "privates.h"
 
 /**
- * SECTION: subscribe-data
- * @Title: ALSASeqSubscribeData
- * @Short_description: A GObject-derived object to represent data for
- *                     subscription between ports.
+ * ALSASeqSubscribeData:
+ * A GObject-derived object to represent data for subscription between ports.
  *
- * A #ALSASeqSubscribeData is a GObject-derived object to represent data for
- * subscription between a pair of ports. The call of
- * alsaseq_get_subscription_list() returns the list of data. The call of
- * alsaseq_user_client_operate_subscription() requires the instance of object.
+ * A [class@SubscribeData] is a GObject-derived object to represent data for subscription between
+ * a pair of ports. The call of [func@get_subscription_list] returns the list of data. The call of
+ * [method@UserClient.operate_subscription] requires the instance of object.
  *
- * The object wraps 'struct snd_seq_port_subscribe' in UAPI of Linux sound
- * subsystem.
+ * The object wraps `struct snd_seq_port_subscribe` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_seq_port_subscribe data;
@@ -136,9 +132,9 @@ static void alsaseq_subscribe_data_init(ALSASeqSubscribeData *self)
 /**
  * alsaseq_subscribe_data_new:
  *
- * Allocates and returns the instance of ALSASeqSubscribeData class.
+ * Allocates and returns the instance of [class@SubscribeData].
  *
- * Returns: A #ALSASeqSubscribeData.
+ * Returns: A [class@SubscribeData].
  */
 ALSASeqSubscribeData *alsaseq_subscribe_data_new()
 {