[gtk/wip/ebassi/constraint-layout] Documentation fixes
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/wip/ebassi/constraint-layout] Documentation fixes
- Date: Mon, 1 Jul 2019 03:18:48 +0000 (UTC)
commit 658397fad0cc5e63af0fed9d134d1c12de045f5d
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Jul 1 03:17:58 2019 +0000
Documentation fixes
Make sure all types show up in the docs,
and misc other improvements.
docs/reference/gtk/gtk4-sections.txt | 3 +++
docs/reference/gtk/gtk4.types.in | 4 ++++
gtk/gtkconstraintguide.c | 7 ++++---
gtk/gtkconstraintlayout.c | 7 ++++---
4 files changed, 15 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index efb544edc6..41b59c5c65 100644
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -7296,12 +7296,15 @@ GtkConstraintTarget
gtk_constraint_new
gtk_constraint_new_constant
gtk_constraint_get_target
+GtkConstraintAttribute
gtk_constraint_get_target_attribute
+GtkConstraintRelation
gtk_constraint_get_relation
gtk_constraint_get_source
gtk_constraint_get_source_attribute
gtk_constraint_get_multiplier
gtk_constraint_get_constant
+GtkConstraintStrength
gtk_constraint_get_strength
gtk_constraint_is_required
gtk_constraint_is_attached
diff --git a/docs/reference/gtk/gtk4.types.in b/docs/reference/gtk/gtk4.types.in
index 8073f3ad20..a03901d769 100644
--- a/docs/reference/gtk/gtk4.types.in
+++ b/docs/reference/gtk/gtk4.types.in
@@ -49,6 +49,10 @@ gtk_color_chooser_dialog_get_type
gtk_color_chooser_widget_get_type
gtk_combo_box_get_type
gtk_combo_box_text_get_type
+gtk_constraint_get_type
+gtk_constraint_guide_get_type
+gtk_constraint_layout_get_type
+gtk_constraint_target_get_type
gtk_container_get_type
gtk_css_provider_get_type
gtk_dialog_get_type
diff --git a/gtk/gtkconstraintguide.c b/gtk/gtkconstraintguide.c
index cb40ff0762..2ae28aac0e 100644
--- a/gtk/gtkconstraintguide.c
+++ b/gtk/gtkconstraintguide.c
@@ -22,9 +22,10 @@
* @Title: GtkConstraintGuide
* @Short_description: An invisible constraint target
*
- * #GtkConstraintGuide is an invisible layout element that can be used by
- * widgets inside a #GtkConstraintLayout as a source or a target of a
- * #GtkConstraint.
+ * A #GtkConstraintGuide is an invisible layout element that can be
+ * used by widgets inside a #GtkConstraintLayout as a source or a target
+ * of a #GtkConstraint. Guides can be used like guidelines or as
+ * flexible space.
*
* Unlike a #GtkWidget, a #GtkConstraintGuide will not be drawn.
*/
diff --git a/gtk/gtkconstraintlayout.c b/gtk/gtkconstraintlayout.c
index 32fdb4f142..751f2d8965 100644
--- a/gtk/gtkconstraintlayout.c
+++ b/gtk/gtkconstraintlayout.c
@@ -1097,6 +1097,7 @@ gtk_constraint_layout_new (void)
* widget using @layout
* - set to the #GtkWidget using @layout
* - set to a child of the #GtkWidget using @layout
+ * - set to a guide that is part of @layout
*
* The @layout acquires the ownership of @constraint after calling
* this function.
@@ -1252,12 +1253,12 @@ gtk_constraint_vfl_parser_error_quark (void)
* @n_lines: the number of lines
* @hspacing: default horizontal spacing value, or -1 for the fallback value
* @vspacing: default vertical spacing value, or -1 for the fallback value
- * @views: (element-type utf8 Gtk.Widget): a dictionary of [ name, widget ]
+ * @views: (element-type utf8 Gtk.ConstraintTarget): a dictionary of [ name, target ]
* pairs; the `name` keys map to the view names in the VFL lines, while
- * the `widget` values map to children of the widget using a #GtkConstraintLayout
+ * the `target` values map to children of the widget using a #GtkConstraintLayout, or guides
* @error: return location for a #GError
*
- * Creates a list of constraints they formal description using a compact
+ * Creates a list of constraints from a formal description using a compact
* description syntax called VFL, or "Visual Format Language".
*
* The Visual Format Language is based on Apple's AutoLayout
[VFL](https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/AutolayoutPG/VisualFormatLanguage.html).
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]