From 71f9149400f2f362fd20e11f641d912cf86fd175 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] rawmidi: substream_params: 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-params.c | 19 +++++++++---------- src/rawmidi/substream-params.h | 1 + 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/rawmidi/substream-params.c b/src/rawmidi/substream-params.c index d4a5552..f9f4d2b 100644 --- a/src/rawmidi/substream-params.c +++ b/src/rawmidi/substream-params.c @@ -4,17 +4,14 @@ #include /** - * SECTION: substream-params - * @Title: ALSARawmidiSubstreamParams - * @Short_description: A GObject-derived object to represent parameters of - * substream. + * ALSARawmidiSubstreamParams: + * A GObject-derived object to represent parameters of substream. * - * A #ALSARawmidiSubstreamParams is a GObject-derived object to represent - * parameters of substream attached to the pair of streams. The call of - * alsarawmidi_stream_pair_set_substream_params() requires the instance of - * object. + * A [class@SubstreamParams] is a GObject-derived object to represent parameters of substream + * attached to the pair of streams. The call of [method@StreamPair.set_substream_params] requires + * the instance of object. * - * The object wraps 'struct snd_rawmidi_params' in UAPI of Linux sound subsystem. + * The object wraps `struct snd_rawmidi_params` in UAPI of Linux sound subsystem. */ typedef struct { struct snd_rawmidi_params params; @@ -118,7 +115,9 @@ static void alsarawmidi_substream_params_init(ALSARawmidiSubstreamParams *self) /** * alsarawmidi_substream_params_new: * - * Allocate and return an instance of [class@SubstreamParams] class. + * Allocate and return an instance of [class@SubstreamParams]. + * + * Returns: An instance of [class@SubstreamParams]. */ ALSARawmidiSubstreamParams *alsarawmidi_substream_params_new() { diff --git a/src/rawmidi/substream-params.h b/src/rawmidi/substream-params.h index 0761057..3d0e0fc 100644 --- a/src/rawmidi/substream-params.h +++ b/src/rawmidi/substream-params.h @@ -10,6 +10,7 @@ G_BEGIN_DECLS G_DECLARE_DERIVABLE_TYPE(ALSARawmidiSubstreamParams, alsarawmidi_substream_params, ALSARAWMIDI, SUBSTREAM_PARAMS, GObject); + struct _ALSARawmidiSubstreamParamsClass { GObjectClass parent_class; }; -- 2.47.3