From 3a68c6037b5069c4171727f52cd1fe2c5539d65d Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] rawmidi: substream_status: 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/rawmidi/substream-status.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/rawmidi/substream-status.c b/src/rawmidi/substream-status.c index 87c1320..be58cd8 100644 --- a/src/rawmidi/substream-status.c +++ b/src/rawmidi/substream-status.c @@ -2,16 +2,14 @@ #include "privates.h" /** - * SECTION: substream-status - * @Title: ALSARawmidiSubstreamStatus - * @Short_description: A GObject-derived object to represent status of substream + * ALSARawmidiSubstreamStatus: + * A GObject-derived object to represent status of substream. * - * A #ALSARawmidiSubstreamStatus is a GObject-derived object to represent status - * of substream attached to the pair of stream. The call of - * alsarawmidi_stream_pair_get_substream_status() returns the instance of - * object. + * A [class@SubstreamStatus] is a GObject-derived object to represent status of substream attached + * to the pair of stream. The call of [method@StreamPair.get_substream_status] returns the instance + * of object. * - * The object wraps 'struct snd_rawmidi_status' in UAPI of Linux sound subsystem. + * The object wraps `struct snd_rawmidi_status` in UAPI of Linux sound subsystem. */ typedef struct { struct snd_rawmidi_status status; @@ -78,7 +76,9 @@ static void alsarawmidi_substream_status_init(ALSARawmidiSubstreamStatus *self) /** * alsarawmidi_substream_status_new: * - * Allocate and return an instance of ALSARawmidiSubstreamStatus class. + * Allocate and return an instance of [class@SubstreamStatus]. + * + * Returns: An instance of [class@SubstreamStatus]. */ ALSARawmidiSubstreamStatus *alsarawmidi_substream_status_new() { -- 2.47.3