Improve documentation
authorLukáš Tyrychtr <lukastyrychtr@gmail.com>
Thu, 15 Sep 2022 16:09:53 +0000 (18:09 +0200)
committerLukáš Tyrychtr <lukastyrychtr@gmail.com>
Thu, 29 Sep 2022 07:36:08 +0000 (09:36 +0200)
gtk/gtkaccessiblerange.c
gtk/gtkaccessiblerange.h

index 363e9545156d4ccc95ca7139a6f79eb6a0940abe..7593012cf2e2800eaaf256ef772ad85c5cd5bffa 100644 (file)
  * In addition to this interface, its implementors are expected to provide the\r
  * correct values for the following properties: %GTK_ACCESSIBLE_PROPERTY_VALUE_MAX,\r
  * %GTK_ACCESSIBLE_PROPERTY_VALUE_MIN and %GTK_ACCESSIBLE_PROPERTY_VALUE_NOW.\r
+ * \r
+ * For controls where a minimum increment makes no sense and which do not allow\r
+ * setting the current value from the user, the default implementation of this\r
+ * interface suffices.\r
  */\r
 \r
 #include "config.h"\r
index 45ffefc257f3756e7b34c54dc7d26283e7ee2932..55da3d688c26191ac95e34d5a9aaae3a4e82bbec 100644 (file)
@@ -37,7 +37,24 @@ struct _GtkAccessibleRangeInterface
 {\r
   GTypeInterface g_iface;\r
 \r
+  /**\r
+   * GtkAccessibleRangeInterface::get_minimum_increment:\r
+   * @self: a `GtkAccessibleRange`\r
+   * \r
+   * Returns the minimum increment for this `GtkAccessibleRange`.\r
+   * The default implementation returns 0.0, which indicates that a minimum\r
+   * increment does not make sense for this implementation.\r
+   * @returns: the minimum increment\r
+   */\r
   double (* get_minimum_increment) (GtkAccessibleRange *self);\r
+  /**\r
+   * GtkAccessibleRangeInterface::set_current_value:\r
+   * @self: a `GtkAccessibleRange`\r
+   * @value: the value to set\r
+   * \r
+   * Sets the current value of @self to @value.\r
+   * This operation should behave similarly as if the user performed the action.\r
+   */\r
   void (* set_current_value) (GtkAccessibleRange *self, double value);\r
 };\r
 \r