[gtk/ebassi/gidocgen: 309/465] customlayout: Convert docs




commit 00e2093f75eaeb00d107b1329adb7f723d6877b6
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Feb 28 13:01:27 2021 -0500

    customlayout: Convert docs

 gtk/gtkcustomlayout.c | 21 +++++++++------------
 gtk/gtkcustomlayout.h |  2 +-
 2 files changed, 10 insertions(+), 13 deletions(-)
---
diff --git a/gtk/gtkcustomlayout.c b/gtk/gtkcustomlayout.c
index 32d2c37a9e..aa64882e2e 100644
--- a/gtk/gtkcustomlayout.c
+++ b/gtk/gtkcustomlayout.c
@@ -1,15 +1,12 @@
 /**
- * SECTION:gtkcustomlayout
- * @Title: GtkCustomLayout
- * @Short_description: A convenience layout manager
+ * GtkCustomLayout:
  *
- * #GtkCustomLayout is a convenience type meant to be used as a transition
- * mechanism between #GtkWidgets implementing a layout policy, and
- * #GtkLayoutManager classes.
+ * `GtkCustomLayout` uses closures for size negotiation.
  *
- * A #GtkCustomLayout uses closures matching to the old #GtkWidget virtual
- * functions for size negotiation, as a convenience API to ease the porting
- * towards the corresponding #GtkLayoutManager virtual functions.
+ * A `GtkCustomLayout `uses closures matching to the old `GtkWidget`
+ * virtual functions for size negotiation, as a convenience API to
+ * ease the porting towards the corresponding `GtkLayoutManager
+ * virtual functions.
  */
 
 #include "config.h"
@@ -98,7 +95,7 @@ gtk_custom_layout_init (GtkCustomLayout *self)
 /**
  * gtk_custom_layout_new:
  * @request_mode: (nullable) (scope call): a function to retrieve
- *   the #GtkSizeRequestMode of the widget using the layout; the
+ *   the `GtkSizeRequestMode` of the widget using the layout; the
  *   default request mode is %GTK_SIZE_REQUEST_CONSTANT_SIZE
  * @measure: (not nullable) (scope call): a function to measure the widget using the layout manager
  * @allocate: (not nullable) (scope call): a function to allocate the children of the widget using
@@ -106,11 +103,11 @@ gtk_custom_layout_init (GtkCustomLayout *self)
  *
  * Creates a new legacy layout manager.
  *
- * Legacy layout managers map to the old #GtkWidget size negotiation
+ * Legacy layout managers map to the old `GtkWidget` size negotiation
  * virtual functions, and are meant to be used during the transition
  * from layout containers to layout manager delegates.
  *
- * Returns: (transfer full): the newly created #GtkCustomLayout
+ * Returns: (transfer full): the newly created `GtkCustomLayout`
  */
 GtkLayoutManager *
 gtk_custom_layout_new (GtkCustomRequestModeFunc request_mode,
diff --git a/gtk/gtkcustomlayout.h b/gtk/gtkcustomlayout.h
index 21beb04853..0dccb7d718 100644
--- a/gtk/gtkcustomlayout.h
+++ b/gtk/gtkcustomlayout.h
@@ -59,7 +59,7 @@ typedef void (* GtkCustomMeasureFunc) (GtkWidget      *widget,
  * @height: the new height of the widget
  * @baseline: the new baseline of the widget, or -1
  *
- * A function to be used by #GtkCustomLayout to allocate a widget.
+ * A function to be used by `GtkCustomLayout` to allocate a widget.
  */
 typedef void (* GtkCustomAllocateFunc) (GtkWidget    *widget,
                                         int           width,


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