From 77893fae20b719dd3e75a6f749e8cb4a1dcba338 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] rawmidi: substream_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/rawmidi/substream-info.c | 23 ++++++++++------------- src/rawmidi/substream-params.c | 2 +- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/src/rawmidi/substream-info.c b/src/rawmidi/substream-info.c index 32deeb5..ed27221 100644 --- a/src/rawmidi/substream-info.c +++ b/src/rawmidi/substream-info.c @@ -2,17 +2,14 @@ #include "privates.h" /** - * SECTION: substream-info - * @Title: ALSARawmidiSubstreamInfo - * @Short_description: A GObject-derived object to represent information of - * substream + * ALSARawmidiSubstreamInfo: + * A GObject-derived object to represent information of substream. * - * A #ALSARawmidiSubstreamInfo is a GObject-derived object to represent - * information of substream attached to the pair of streams. The call of - * alsarawmidi_stream_pair_get_substream_info() or - * alsarawmidi_get_substream_info() return the instance of object. + * A [class@SubstreamInfo] is a GObject-derived object to represent information of substream + * attached to the pair of streams. The call of [method@StreamPair.get_substream_info] or + * [func@get_substream_info] return the instance of object. * - * The object wraps 'struct snd_rawmidi_info' in UAPI of Linux sound subsystem. + * The object wraps `struct snd_rawmidi_info` in UAPI of Linux sound subsystem. */ typedef struct { struct snd_rawmidi_info info; @@ -86,14 +83,14 @@ static void alsarawmidi_substream_info_class_init(ALSARawmidiSubstreamInfoClass rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_DEVICE_ID] = g_param_spec_uint("device-id", "device-id", - "The numerical ID of rawmidi device.", + "The numerical identifier of rawmidi device.", 0, G_MAXINT, 0, G_PARAM_READABLE); rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_SUBDEVICE_ID] = g_param_spec_uint("subdevice-id", "subdevice-id", - "The numerical ID of subdevice for rawmidi device..", + "The numerical identifier of subdevice for rawmidi device..", 0, G_MAXINT, 0, G_PARAM_READABLE); @@ -108,7 +105,7 @@ static void alsarawmidi_substream_info_class_init(ALSARawmidiSubstreamInfoClass rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_CARD_ID] = g_param_spec_int("card-id", "card-id", - "The numerical ID of sound card.", + "The numerical identifier of sound card.", G_MININT, G_MAXINT, -1, G_PARAM_READABLE); @@ -123,7 +120,7 @@ static void alsarawmidi_substream_info_class_init(ALSARawmidiSubstreamInfoClass rawmidi_substream_info_props[RAWMIDI_SUBSTREAM_INFO_PROP_ID] = g_param_spec_string("id", "id", - "The string ID of rawmidi device.", + "The string identifier of rawmidi device.", "", G_PARAM_READABLE); diff --git a/src/rawmidi/substream-params.c b/src/rawmidi/substream-params.c index eb5e7ce..d4a5552 100644 --- a/src/rawmidi/substream-params.c +++ b/src/rawmidi/substream-params.c @@ -118,7 +118,7 @@ static void alsarawmidi_substream_params_init(ALSARawmidiSubstreamParams *self) /** * alsarawmidi_substream_params_new: * - * Allocate and return an instance of ALSARawmidiSubstreamParams class. + * Allocate and return an instance of [class@SubstreamParams] class. */ ALSARawmidiSubstreamParams *alsarawmidi_substream_params_new() { -- 2.47.3