editable: Clarify the docs
authorMatthias Clasen <mclasen@redhat.com>
Tue, 31 Aug 2021 12:41:45 +0000 (08:41 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 2 Sep 2021 23:59:41 +0000 (19:59 -0400)
Make it clear that your class must have all the editable properties
already before you call the (confusingly named) function
gtk_editable_install_properties.

gtk/gtkeditable.c

index c8386afe21a698db0871b8b98104905225629198..a9517e1c1e1ac46f8de5c16b084b51c5e4d875fb 100644 (file)
@@ -945,11 +945,15 @@ gtk_editable_set_enable_undo (GtkEditable *editable,
  * @object_class: a `GObjectClass`
  * @first_prop: property ID to use for the first property
  *
- * Installs the `GtkEditable` properties for @class.
+ * Overrides the `GtkEditable` properties for @class.
  *
  * This is a helper function that should be called in class_init,
  * after installing your own properties.
  *
+ * Note that your class must have "text", "cursor-position",
+ * "selection-bound", "editable", "width-chars", "max-width-chars",
+ * "xalign" and "enable-undo" properties for this function to work.
+ *
  * To handle the properties in your set_property and get_property
  * functions, you can either use [func@Gtk.Editable.delegate_set_property]
  * and [func@Gtk.Editable.delegate_get_property] (if you are using