[gtk/ebassi/gidocgen: 196/471] colorchooserdialog: Convert docs




commit c2f49825d238fa5ec78dfe621d14519eb7762e55
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Feb 26 11:25:46 2021 -0500

    colorchooserdialog: Convert docs
    
    Convert link syntax, add example image, clean things up.

 gtk/gtkcolorchooserdialog.c | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)
---
diff --git a/gtk/gtkcolorchooserdialog.c b/gtk/gtkcolorchooserdialog.c
index a6273cdd09..ade93e89a4 100644
--- a/gtk/gtkcolorchooserdialog.c
+++ b/gtk/gtkcolorchooserdialog.c
@@ -30,13 +30,20 @@
 #include "gtkcolorchooserwidget.h"
 
 /**
- * SECTION:gtkcolorchooserdialog
- * @Short_description: A dialog for choosing colors
- * @Title: GtkColorChooserDialog
- * @See_also: #GtkColorChooser, #GtkDialog
+ * GtkColorChooserDialog:
  *
- * The #GtkColorChooserDialog widget is a dialog for choosing
- * a color. It implements the #GtkColorChooser interface.
+ * A dialog for choosing a color.
+ *
+ * ![An example GtkColorChooserDialog](colorchooser.png)
+ *
+ * `GtkColorChooserDialog` implements the `GtkColorChooser` interface
+ * and does not provide much API of its own.
+ *
+ * To create a `GtkColorChooserDialog`, use [ctor Gtk ColorChooserDialog new].
+ *
+ * To change the initially selected color, use
+ * [method@Gtk.ColorChooser.set_rgba]. To get the selected color use
+ * [method@Gtk.ColorChooser.get_rgba].
  */
 
 typedef struct _GtkColorChooserDialogClass   GtkColorChooserDialogClass;
@@ -272,9 +279,9 @@ gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface)
  * @title: (allow-none): Title of the dialog, or %NULL
  * @parent: (allow-none): Transient parent of the dialog, or %NULL
  *
- * Creates a new #GtkColorChooserDialog.
+ * Creates a new `GtkColorChooserDialog`.
  *
- * Returns: a new #GtkColorChooserDialog
+ * Returns: a new `GtkColorChooserDialog`
  */
 GtkWidget *
 gtk_color_chooser_dialog_new (const char *title,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]