Fix documentation of gdk_display_put_event()
authorMichael Catanzaro <mcatanzaro@redhat.com>
Fri, 8 Sep 2023 21:21:33 +0000 (16:21 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 19 Sep 2023 20:32:27 +0000 (16:32 -0400)
This function is deprecated, but we should still document it properly.
It appends, not prepends. This is clear enough from its implementation,
but also we have practical experience with WebKit in:

https://github.com/WebKit/WebKit/pull/8663

Matthias prefers to avoid the prepend, append, start, and end
terminology altogether.

gdk/gdkdisplay.c

index c1a11672da86c91684f2189fa928b9c170aedc26..3ea82a57434e97e74659d227d488b9a30229c66d 100644 (file)
@@ -473,8 +473,7 @@ gdk_display_get_event (GdkDisplay *display)
  * @display: a `GdkDisplay`
  * @event: (transfer none): a `GdkEvent`
  *
- * Appends the given event onto the front of the event
- * queue for @display.
+ * Adds the given event to the event queue for @display.
  *
  * Deprecated: 4.10: This function is only useful in very
  * special situations and should not be used by applications.