From: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Date: Mon, 20 Jun 2022 09:44:49 +0000 (+0900)
Subject: rawmidi: substream-params: add annotation to object properties
X-Git-Tag: v0.3.0~56
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=4524b7e2dab6ab68a1e38e96416660c36cba098e;p=alsa-gobject.git

rawmidi: substream-params: add annotation to object properties

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
---

diff --git a/src/rawmidi/substream-params.c b/src/rawmidi/substream-params.c
index f9f4d2b..2cc02f6 100644
--- a/src/rawmidi/substream-params.c
+++ b/src/rawmidi/substream-params.c
@@ -80,6 +80,11 @@ static void alsarawmidi_substream_params_class_init(ALSARawmidiSubstreamParamsCl
     gobject_class->set_property = rawmidi_substream_params_set_property;
     gobject_class->get_property = rawmidi_substream_params_get_property;
 
+    /**
+     * ALSARawmidiSubstreamParams:buffer-size:
+     *
+     * The size of intermediate buffer for substream.
+     */
     rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_BUFFER_SIZE] =
         g_param_spec_uint("buffer-size", "buffer-size",
                           "The size of intermediate buffer for substream.",
@@ -87,18 +92,27 @@ static void alsarawmidi_substream_params_class_init(ALSARawmidiSubstreamParamsCl
                           page_size,
                           G_PARAM_READWRITE);
 
+    /**
+     * ALSARawmidiSubstreamParams:avail-min:
+     * 
+     * The threshold to wake up from any blocking operation such as poll(2), read(2) and write(2).
+     */
     rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_AVAIL_MIN] =
         g_param_spec_uint("avail-min", "avail-min",
-                          "The threshold to wake up from any blocking "
-                          "operation such as poll(2), read(2) and write(2).",
+                          "The threshold to wake up from any blocking operation such as poll(2), "
+                          "read(2) and write(2).",
                           1, G_MAXUINT,
                           1,
                           G_PARAM_READWRITE);
 
+    /**
+     * ALSARawmidiSubstreamParams:active-sensing:
+     *
+     * Whether to emit 0xfe one time when closing substream.
+     */
     rawmidi_substream_params_props[RAWMIDI_SUBSTREAM_PARAMS_PROP_ACTIVE_SENSING] =
         g_param_spec_boolean("active-sensing", "active-sensing",
-                             "Whether to emit 0xfe one time when closing "
-                             "substream.",
+                             "Whether to emit 0xfe one time when closing substream.",
                              FALSE,
                              G_PARAM_READWRITE);