]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: client_pool: 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/client-pool.c

index c363f7376103a2385730c6685dc4d7fb2c72a166..bd745e319d609301b63e5a40109b76e323060869 100644 (file)
@@ -2,18 +2,15 @@
 #include "privates.h"
 
 /**
- * SECTION: client-pool
- * @Title: ALSASeqClientPool
- * @Short_description: A GObject-derived object to represent information of
- *                     pool owned by client.
+ * ALSASeqClientPool:
+ * A GObject-derived object to represent information of pool owned by client.
  *
- * A #ALSASeqClientPool is a GObject-derived object to represent information of
- * pool owned by client. The pool consists of a batch of cells to store message
- * contents in kernel space. The call of alsaseq_get_client_pool() returns the
- * instance of object. The call of alsaseq_user_client_set_pool() and
- * alsaseq_user_client_get_pool() require the instance of object.
+ * A [class@ClientPool] is a GObject-derived object to represent information of pool owned by
+ * client. The pool consists of a batch of cells to store message contents in kernel space. The
+ * call of [func@get_client_pool] returns the instance of object. The call of
+ * [method@UserClient.set_pool]) and [method@UserClient.get_pool] require the instance of object.
  *
- * The object wraps 'struct snd_seq_client_pool' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_seq_client_pool` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_seq_client_pool pool;