colorchooser: Document actions
authorMatthias Clasen <mclasen@redhat.com>
Mon, 23 Dec 2019 18:36:32 +0000 (13:36 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 23 Dec 2019 18:39:05 +0000 (13:39 -0500)
This is mainly a trial balloon for gtk-doc
support for this syntax.

See https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/30

gtk/gtkcolorchooserwidget.c

index 17131ef1991b1f9d3a782c755d635d0c17066190..526726fce7e3ef3efefb9e1ab1d08b202a75f712 100644 (file)
@@ -708,8 +708,28 @@ gtk_color_chooser_widget_class_init (GtkColorChooserWidgetClass *class)
   gtk_widget_class_set_css_name (widget_class, I_("colorchooser"));
   gtk_widget_class_set_layout_manager_type (widget_class, GTK_TYPE_BOX_LAYOUT);
 
+  /**
+   * GtkColorChooserWidget|color.select:
+   * @red: the red value, between 0 and 1
+   * @green: the green value, between 0 and 1
+   * @blue: the blue value, between 0 and 1
+   * @alpha: the alpha value, between 0 and 1
+   *
+   * Emits the #GtkColorChooser::color-activated signal for
+   * the given color.
+   */
   gtk_widget_class_install_action (widget_class, "color.select", "(dddd)",
                                    gtk_color_chooser_widget_activate_color_select);
+
+  /**
+   * GtkColorChooserWidget|color.customize:
+   * @red: the red value, between 0 and 1
+   * @green: the green value, between 0 and 1
+   * @blue: the blue value, between 0 and 1
+   * @alpha: the alpha value, between 0 and 1
+   *
+   * Activates the color editor for the given color.
+   */
   gtk_widget_class_install_action (widget_class, "color.customize", "(dddd)",
                                    gtk_color_chooser_widget_activate_color_customize);
 }