[gtk/ebassi/gidocgen: 60/471] docs: Move GdkEvent docs inline




commit 43a288f1aaec600693bd7f5a3ba0cb0e1a04deec
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Feb 20 10:26:17 2021 -0500

    docs: Move GdkEvent docs inline
    
    This is not really worth a chapter of its own.

 docs/reference/gdk/events.md    | 10 ----------
 docs/reference/gdk/gdk4.toml.in |  1 -
 gdk/gdkevents.c                 |  8 ++++++--
 3 files changed, 6 insertions(+), 13 deletions(-)
---
diff --git a/docs/reference/gdk/gdk4.toml.in b/docs/reference/gdk/gdk4.toml.in
index e283f9fa0f..da74d0cfd0 100644
--- a/docs/reference/gdk/gdk4.toml.in
+++ b/docs/reference/gdk/gdk4.toml.in
@@ -34,7 +34,6 @@ base_url = "https://gitlab.gnome.org/GNOME/gtk/-/blob/master/";
 
 [extra]
 content_files = [
-  "events.md",
   "keys.md",
   "cairo.md",
   "pango.md",
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 43692c4f95..c4548aa227 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -41,8 +41,12 @@
 /**
  * GdkEvent: (ref-func gdk_event_ref) (unref-func gdk_event_unref)
  *
- * The GdkEvent struct contains only private fields and
- * should not be accessed directly.
+ * `GdkEvent` and its derived types are immutable data structures,
+ * created by GTK itself to represent windowing system events.
+ *
+ * In GTK applications the events are handled automatically by toplevel
+ * widgets and passed on to the event controllers of appropriate widgets,
+ * so using `GdkEvent` and its related API is rarely needed.
  */
 
 /**


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