]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
rawmidi: substream_status: link optimization to gi-docgen
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Wed, 20 Apr 2022 00:51:44 +0000 (09:51 +0900)
The gi-docgen supports enhancement of inter-document link. This commit is
optimization to it.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/rawmidi/substream-status.c

index 87c1320300fcefcc1ac8f962c1334562e6d79c82..be58cd84993d75d2e63e43b728b4bfd997d64d21 100644 (file)
@@ -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()
 {