]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: instance-params: add annotation to object properties
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 09:44:49 +0000 (18:44 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 20 Jun 2022 09:44:49 +0000 (18:44 +0900)
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/timer/instance-params.c

index d38ae5a5ce30824c8a7e1ef916cc1c9ead39539c..c6fbe7c7b2adc5c7f8ab783e6e2ef9f3581e2947 100644 (file)
@@ -79,14 +79,23 @@ static void alsatimer_instance_params_class_init(ALSATimerInstanceParamsClass *k
     gobject_class->set_property = timer_instance_params_set_property;
     gobject_class->get_property = timer_instance_params_get_property;
 
+    /**
+     * ALSATimerInstanceParams:flags:
+     *
+     * The flags for user instance, as a set of [flags@InstanceParamFlag].
+     */
     timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_FLAGS] =
         g_param_spec_flags("flags", "flags",
-                           "The flags for user instance, as a set of "
-                           "ALSATimerInstanceParamFlag",
+                           "The flags for user instance, as a set of ALSATimerInstanceParamFlag",
                            ALSATIMER_TYPE_INSTANCE_PARAM_FLAG,
                            0,
                            G_PARAM_READWRITE);
 
+    /**
+     * ALSATimerInstanceParams:interval:
+     *
+     * The interval to generate event in tick count.
+     */
     timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_INTERVAL] =
         g_param_spec_uint("interval", "interval",
                           "The interval to generate event in tick count.",
@@ -94,6 +103,11 @@ static void alsatimer_instance_params_class_init(ALSATimerInstanceParamsClass *k
                           0,
                           G_PARAM_READWRITE);
 
+    /**
+     * ALSATimerInstanceParams:queue-size:
+     *
+     * The size of queue.
+     */
     timer_instance_params_props[TIMER_INSTANCE_PARAMS_PROP_QUEUE_SIZE] =
         g_param_spec_uint("queue-size", "queue-size",
                           "The size of queue.",