[gtk/ebassi/gidocgen: 401/478] widgetpaintable: Convert docs




commit 5ee9d920318f4d492b72db282886e23694c41b29
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Mar 1 01:47:47 2021 -0500

    widgetpaintable: Convert docs

 gtk/gtkwidgetpaintable.c | 57 ++++++++++++++++++++++--------------------------
 1 file changed, 26 insertions(+), 31 deletions(-)
---
diff --git a/gtk/gtkwidgetpaintable.c b/gtk/gtkwidgetpaintable.c
index 1ed017db9e..dbea4abe15 100644
--- a/gtk/gtkwidgetpaintable.c
+++ b/gtk/gtkwidgetpaintable.c
@@ -27,31 +27,28 @@
 #include "gtkwidgetprivate.h"
 
 /**
- * SECTION:gtkwidgetpaintable
- * @Short_description: Drawing a widget elsewhere
- * @Title: GtkWidgetPaintable
- * @see_also: #GtkWidget, #GdkPaintable
+ * GtkWidgetPaintable:
  *
- * GtkWidgetPaintable is an implementation of the #GdkPaintable interface 
- * that allows displaying the contents of a #GtkWidget.
+ * `GtkWidgetPaintable` is a `GdkPaintable` that displays the contents
+ * of a widget.
  *
- * GtkWidgetPaintable will also take care of the widget not being in a
+ * `GtkWidgetPaintable` will also take care of the widget not being in a
  * state where it can be drawn (like when it isn't shown) and just draw
  * nothing or where it does not have a size (like when it is hidden) and
  * report no size in that case.
  *
- * Of course, GtkWidgetPaintable allows you to monitor widgets for size
- * changes by emitting the #GdkPaintable::invalidate-size signal whenever
- * the size of the widget changes as well as for visual changes by
- * emitting the #GdkPaintable::invalidate-contents signal whenever the
- * widget changes.
+ * Of course, `GtkWidgetPaintable` allows you to monitor widgets for size
+ * changes by emitting the [signal@Gdk.Paintable::invalidate-size] signal
+ * whenever the size of the widget changes as well as for visual changes by
+ * emitting the [signal@Gdk.Paintable::invalidate-contents] signal whenever
+ * the widget changes.
  *
- * You can of course use a GtkWidgetPaintable everywhere a
- * #GdkPaintable is allowed, including using it on a #GtkPicture (or one
- * of its parents) that it was set on itself via gtk_picture_set_paintable().
- * The paintable will take care of recursion when this happens. If you do
- * this however, ensure the #GtkPicture:can-shrink property is set to
- * %TRUE or you might end up with an infinitely growing widget.
+ * You can use a `GtkWidgetPaintable` everywhere a `GdkPaintable` is allowed,
+ * including using it on a `GtkPicture` (or one of its parents) that it was
+ * set on itself via gtk_picture_set_paintable(). The paintable will take care
+ * of recursion when this happens. If you do this however, ensure that the
+ * [property@Gtk.Picture:can-shrink] property is set to %TRUE or you might
+ * end up with an infinitely growing widget.
  */
 struct _GtkWidgetPaintable
 {
@@ -241,7 +238,7 @@ gtk_widget_paintable_class_init (GtkWidgetPaintableClass *klass)
   gobject_class->finalize = gtk_widget_paintable_finalize;
 
   /**
-   * GtkWidgetPaintable:widget
+   * GtkWidgetPaintable:widget: (attributes org.gtk.Property.get=gtk_widget_paintable_get_widget 
org.gtk.Property.set=gtk_widget_paintable_set_widget)
    *
    * The observed widget or %NULL if none.
    */
@@ -263,12 +260,12 @@ gtk_widget_paintable_init (GtkWidgetPaintable *self)
 
 /**
  * gtk_widget_paintable_new:
- * @widget: (allow-none) (transfer none): a #GtkWidget or %NULL
+ * @widget: (allow-none) (transfer none): a `GtkWidget` or %NULL
  *
  * Creates a new widget paintable observing the given widget.
  *
- * Returns: (transfer full) (type GtkWidgetPaintable): a new #GtkWidgetPaintable
- **/
+ * Returns: (transfer full) (type GtkWidgetPaintable): a new `GtkWidgetPaintable`
+ */
 GdkPaintable *
 gtk_widget_paintable_new (GtkWidget *widget)
 {
@@ -297,14 +294,13 @@ gtk_widget_paintable_snapshot_widget (GtkWidgetPaintable *self)
 }
 
 /**
- * gtk_widget_paintable_get_widget:
- * @self: a #GtkWidgetPaintable
+ * gtk_widget_paintable_get_widget: (attributes org.gtk.Method.get_property=widget)
+ * @self: a `GtkWidgetPaintable`
  *
- * Returns the widget that is observed or %NULL
- * if none.
+ * Returns the widget that is observed or %NULL if none.
  *
  * Returns: (transfer none) (nullable): the observed widget.
- **/
+ */
 GtkWidget *
 gtk_widget_paintable_get_widget (GtkWidgetPaintable *self)
 {
@@ -314,12 +310,12 @@ gtk_widget_paintable_get_widget (GtkWidgetPaintable *self)
 }
 
 /**
- * gtk_widget_paintable_set_widget:
- * @self: a #GtkWidgetPaintable
+ * gtk_widget_paintable_set_widget: (attributes org.gtk.Method.set_property=widget)
+ * @self: a `GtkWidgetPaintable`
  * @widget: (allow-none): the widget to observe or %NULL
  *
  * Sets the widget that should be observed.
- **/
+ */
 void
 gtk_widget_paintable_set_widget (GtkWidgetPaintable *self,
                                  GtkWidget          *widget)
@@ -408,4 +404,3 @@ gtk_widget_paintable_pop_snapshot_count (GtkWidgetPaintable *self)
 {
   self->snapshot_count--;
 }
-


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