[gtk/matthiasc/for-master: 29/41] eventcontroller: Cosmetic docs changes




commit 9a7e4f43046f78e1438e16a761c9a672535d9374
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat May 22 14:27:25 2021 -0400

    eventcontroller: Cosmetic docs changes

 gtk/gtkeventcontroller.c | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)
---
diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c
index 987bfcd7ae..6892562901 100644
--- a/gtk/gtkeventcontroller.c
+++ b/gtk/gtkeventcontroller.c
@@ -30,7 +30,7 @@
  * [method@Gtk.Widget.add_controller]. It is rarely necessary to
  * explicitly remove a controller with [method@Gtk.Widget.remove_controller].
  *
- * See the chapter of [input handling](input-handling.html) for
+ * See the chapter on [input handling](input-handling.html) for
  * an overview of the basic concepts, such as the capture and bubble
  * phases of even propagation.
  */
@@ -593,8 +593,9 @@ gtk_event_controller_get_target (GtkEventController *controller)
  * gtk_event_controller_get_current_event:
  * @controller: a `GtkEventController`
  *
- * Returns the event that is currently being handled by the
- * controller, and %NULL at other times.
+ * Returns the event that is currently being handled by the controller.
+ *
+ * At other times, %NULL is returned.
  *
  * Returns: (nullable) (transfer none): the event that is currently
  *   handled by @controller
@@ -612,7 +613,9 @@ gtk_event_controller_get_current_event (GtkEventController *controller)
  * @controller: a `GtkEventController`
  *
  * Returns the timestamp of the event that is currently being
- * handled by the controller, and 0 otherwise.
+ * handled by the controller.
+ *
+ * At other times, 0 is returned.
  *
  * Returns: timestamp of the event is currently handled by @controller
  */
@@ -632,7 +635,9 @@ gtk_event_controller_get_current_event_time (GtkEventController *controller)
  * @controller: a `GtkEventController`
  *
  * Returns the device of the event that is currently being
- * handled by the controller, and %NULL otherwise.
+ * handled by the controller.
+ *
+ * At other times, %NULL is returned.
  *
  * Returns: (nullable) (transfer none): device of the event is
  *   currently handled by @controller
@@ -653,7 +658,9 @@ gtk_event_controller_get_current_event_device (GtkEventController *controller)
  * @controller: a `GtkEventController`
  *
  * Returns the modifier state of the event that is currently being
- * handled by the controller, and 0 otherwise.
+ * handled by the controller.
+ *
+ * At other times, 0 is returned.
  *
  * Returns: modifier state of the event is currently handled by @controller
  */


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