From: Takashi Sakamoto Date: Tue, 19 Apr 2022 09:41:08 +0000 (+0900) Subject: seq: client_pool: link optimization to gi-docgen X-Git-Tag: v0.3.0~157 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=a37bccd00f8405b118743a3e86d6d43fd90ae72f;p=alsa-gobject.git seq: client_pool: link optimization to gi-docgen The gi-docgen supports enhancement of inter-document link. This commit is optimization to it. Signed-off-by: Takashi Sakamoto --- diff --git a/src/seq/client-pool.c b/src/seq/client-pool.c index c363f73..bd745e3 100644 --- a/src/seq/client-pool.c +++ b/src/seq/client-pool.c @@ -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;