From: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Date: Tue, 19 Apr 2022 09:41:08 +0000 (+0900)
Subject: rawmidi: substream_params: link optimization to gi-docgen
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=2c0eefbf5e26d43577aeb0d57e0c0ba787c85612;p=alsa-gobject.git

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 <o-takashi@sakamocchi.jp>
---

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 <unistd.h>
 
 /**
- * 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;
 };