]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
rawmidi: substream-params: add annotation to object properties
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 09:44:49 +0000 (18:44 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 23:22:25 +0000 (08:22 +0900)
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/rawmidi/substream-params.c

index f9f4d2b84b836601f22b5b2a1662c3eaf7b8efd2..2cc02f6e7f26efeab2be4b03629afb7b1949c8d9 100644 (file)
@@ -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);