From d88a38f3731e7e94b2e9ffef9cbc0af2949d59f1 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] seq: port_info: 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 --- src/seq/port-info.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/seq/port-info.c b/src/seq/port-info.c index c1b1178..40d8f9e 100644 --- a/src/seq/port-info.c +++ b/src/seq/port-info.c @@ -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() { -- 2.47.3