GNOME.org
 

[gtk/ebassi/docs-for-master: 1/20] docs: Complete symbol coverage for GDK


commit a1a4dce8c3b6c6bf01890f03f67bdd37870c4a2f
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Wed Dec 16 14:40:12 2020 +0000

    docs: Complete symbol coverage for GDK
    
    100% symbol docs coverage.
    833 symbols documented.
    0 symbols incomplete.
    0 not documented.
    
    What's left are just type system macros and windowing system opaque
    structures.

 docs/reference/gdk/gdk4-sections.txt | 45 +++++++++++++++++++--
 docs/reference/gdk/meson.build       |  3 ++
 gdk/gdkevents.c                      | 78 ++++++++++++++++++++++++++++++++++++
 gdk/gdksurface.c                     |  6 +++
 gdk/gdkversionmacros.h.in            | 17 ++++++++
 5 files changed, 146 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/gdk/gdk4-sections.txt b/docs/reference/gdk/gdk4-sections.txt
index 22c4646caf..2c82ab8d92 100644
--- a/docs/reference/gdk/gdk4-sections.txt
+++ b/docs/reference/gdk/gdk4-sections.txt
@@ -1,4 +1,3 @@
-
 <INCLUDE>gdk/gdk.h</INCLUDE>
 
 <SECTION>
@@ -29,8 +28,9 @@ GDK_TYPE_GRAB_STATUS
 GDK_TYPE_STATUS
 GdkStatus
 GDKVAR
-GDK_VERSION_3_92
-GDK_VERSION_3_94
+GDK_EXTERN_VAR
+_GDK_EXTERN
+GDK_DECLARE_INTERNAL_TYPE
 gdk_axis_use_get_type
 gdk_byte_order_get_type
 gdk_crossing_mode_get_type
@@ -375,6 +375,7 @@ gdk_device_tool_get_hardware_id
 gdk_device_tool_get_axes
 
 <SUBSECTION Standard>
+GDK_TYPE_AXIS_FLAGS
 GDK_TYPE_AXIS_USE
 GDK_TYPE_EXTENSION_MODE
 GDK_TYPE_INPUT_MODE
@@ -447,6 +448,7 @@ gdk_seat_capabilities_get_type
 <FILE>events</FILE>
 GdkEvent
 GdkEventType
+GdkKeymapKey
 GdkKeyMatch
 GdkTouchpadGesturePhase
 GdkScrollDirection
@@ -482,10 +484,14 @@ gdk_event_get_axis
 gdk_event_get_history
 gdk_event_get_pointer_emulated
 gdk_event_triggers_context_menu
+GdkButtonEvent
 gdk_button_event_get_button
+GdkScrollEvent
 gdk_scroll_event_get_direction
 gdk_scroll_event_get_deltas
 gdk_scroll_event_is_stop
+GdkMotionEvent
+GdkKeyEvent
 gdk_key_event_get_keyval
 gdk_key_event_get_keycode
 gdk_key_event_get_consumed_modifiers
@@ -494,22 +500,31 @@ gdk_key_event_get_level
 gdk_key_event_is_modifier
 gdk_key_event_matches
 gdk_key_event_get_match
+GdkFocusEvent
 gdk_focus_event_get_in
 gdk_touch_event_get_emulating_pointer
+GdkCrossingEvent
 gdk_crossing_event_get_mode
 gdk_crossing_event_get_detail
 gdk_crossing_event_get_focus
+GdkGrabBrokenEvent
 gdk_grab_broken_event_get_grab_surface
 gdk_grab_broken_event_get_implicit
+GdkDeleteEvent
+GdkDNDEvent
 gdk_dnd_event_get_drop
+GdkTouchEvent
+GdkTouchpadEvent
 gdk_touchpad_event_get_gesture_phase
 gdk_touchpad_event_get_n_fingers
 gdk_touchpad_event_get_deltas
 gdk_touchpad_event_get_pinch_angle_delta
 gdk_touchpad_event_get_pinch_scale
+GdkPadEvent
 gdk_pad_event_get_axis_value
 gdk_pad_event_get_button
 gdk_pad_event_get_group_mode
+GdkProximityEvent
 
 <SUBSECTION>
 gdk_events_get_angle
@@ -517,6 +532,7 @@ gdk_events_get_center
 gdk_events_get_distance
 
 <SUBSECTION Standard>
+GDK_EVENT
 GDK_TYPE_EVENT
 GDK_TYPE_EVENT_MASK
 GDK_TYPE_EVENT_TYPE
@@ -524,6 +540,20 @@ GDK_TYPE_CROSSING_MODE
 GDK_TYPE_SCROLL_DIRECTION
 GDK_TYPE_NOTIFY_TYPE
 GDK_IS_EVENT
+GDK_IS_EVENT_TYPE
+GDK_TYPE_BUTTON_EVENT
+GDK_TYPE_CROSSING_EVENT
+GDK_TYPE_DELETE_EVENT
+GDK_TYPE_DND_EVENT
+GDK_TYPE_FOCUS_EVENT
+GDK_TYPE_GRAB_BROKEN_EVENT
+GDK_TYPE_KEY_EVENT
+GDK_TYPE_MOTION_EVENT
+GDK_TYPE_PAD_EVENT
+GDK_TYPE_PROXIMITY_EVENT
+GDK_TYPE_SCROLL_EVENT
+GDK_TYPE_TOUCH_EVENT
+GDK_TYPE_TOUCHPAD_EVENT
 
 gdk_event_get_type
 gdk_event_sequence_get_type
@@ -1173,6 +1203,10 @@ GdkCairoContext
 gdk_cairo_context_cairo_create
 
 <SUBSECTION Standard>
+GDK_CAIRO_CONTEXT
+GDK_IS_CAIRO_CONTEXT
+GDK_TYPE_CAIRO_CONTEXT
+GDK_CAIRO_ERROR
 gdk_cairo_context_get_type
 </SECTION>
 
@@ -1192,6 +1226,11 @@ gdk_vulkan_context_get_queue
 gdk_vulkan_context_get_queue_family_index
 
 <SUBSECTION Standard>
+GDK_VULKAN_CONTEXT
+GDK_IS_VULKAN_CONTEXT
+GDK_TYPE_VULKAN_CONTEXT
+GDK_RENDERING_VULKAN
+GDK_VULKAN_ERROR
 gdk_vulkan_context_get_type
 gdk_vulkan_error_quark
 gdk_vulkan_strerror
diff --git a/docs/reference/gdk/meson.build b/docs/reference/gdk/meson.build
index be256e9175..c895131a3d 100644
--- a/docs/reference/gdk/meson.build
+++ b/docs/reference/gdk/meson.build
@@ -45,10 +45,13 @@ private_headers = [
   'gdktoplevelprivate.h',
   'gdktoplevelsizeprivate.h',
   'gdkvulkancontextprivate.h',
+
   'filetransferportalprivate.h',
+  'gdkconstructor.h',
   'keyname-table.h',
 
   # gdk/x11
+  'gdkasync.h',
   'gdkcairocontext-x11.h',
   'gdkclipboard-x11.h',
   'gdkdevice-xi2-private.h',
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 30dee67dcd..141a95a283 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -1314,6 +1314,12 @@ gdk_event_get_position (GdkEvent *event,
 
 /* {{{ GdkButtonEvent */
 
+/**
+ * GdkButtonEvent:
+ *
+ * An event related to a button on a pointer device/
+ */
+
 static void
 gdk_button_event_finalize (GdkEvent *event)
 {
@@ -1438,6 +1444,12 @@ gdk_button_event_get_button (GdkEvent *event)
 
 /* {{{ GdkKeyEvent */
 
+/**
+ * GdkKeyEvent:
+ *
+ * An event related to a key-based device.
+ */
+
 static GdkModifierType
 gdk_key_event_get_state (GdkEvent *event)
 {
@@ -1819,6 +1831,12 @@ gdk_key_event_get_match (GdkEvent        *event,
 
 /* {{{ GdkTouchEvent */
 
+/**
+ * GdkTouchEvent:
+ *
+ * An event related to a touch-based device.
+ */
+
 static void
 gdk_touch_event_finalize (GdkEvent *event)
 {
@@ -1950,6 +1968,12 @@ gdk_touch_event_get_emulating_pointer (GdkEvent *event)
 
 /* {{{ GdkCrossingEvent */
 
+/**
+ * GdkCrossingEvent:
+ *
+ * An event caused by a pointing device moving between surfaces.
+ */
+
 static void
 gdk_crossing_event_finalize (GdkEvent *event)
 {
@@ -2088,6 +2112,12 @@ gdk_crossing_event_get_detail (GdkEvent *event)
 
 /* {{{ GdkDeleteEvent */
 
+/**
+ * GdkDeleteEvent:
+ *
+ * An event related to closing a top-level surface.
+ */
+
 static const GdkEventTypeInfo gdk_delete_event_info = {
   sizeof (GdkDeleteEvent),
   NULL,
@@ -2113,6 +2143,12 @@ gdk_delete_event_new (GdkSurface *surface)
 
 /* {{{ GdkFocusEvent */
 
+/**
+ * GdkFocusEvent:
+ *
+ * An event related to a focus change.
+ */
+
 static const GdkEventTypeInfo gdk_focus_event_info = {
   sizeof (GdkFocusEvent),
   NULL,
@@ -2164,6 +2200,12 @@ gdk_focus_event_get_in (GdkEvent *event)
 
 /* {{{ GdkScrollEvent */
 
+/**
+ * GdkScrollEvent:
+ *
+ * An event related to a scrolling motion.
+ */
+
 static void
 gdk_scroll_event_finalize (GdkEvent *event)
 {
@@ -2321,6 +2363,12 @@ gdk_scroll_event_is_stop (GdkEvent *event)
 
 /* {{{ GdkTouchpadEvent */
 
+/**
+ * GdkTouchpadEvent:
+ *
+ * An event related to a touchpad device.
+ */
+
 static GdkModifierType
 gdk_touchpad_event_get_state (GdkEvent *event)
 {
@@ -2517,6 +2565,12 @@ gdk_touchpad_event_get_pinch_scale (GdkEvent *event)
 
 /* {{{ GdkPadEvent */
 
+/**
+ * GdkPadEvent:
+ *
+ * An event related to a pad-based device.
+ */
+
 static const GdkEventTypeInfo gdk_pad_event_info = {
   sizeof (GdkPadEvent),
   NULL,
@@ -2685,6 +2739,12 @@ gdk_pad_event_get_group_mode (GdkEvent *event,
 
 /* {{{ GdkMotionEvent */
 
+/**
+ * GdkMotionEvent:
+ *
+ * An event related to a pointer or touch device motion.
+ */
+
 static void
 gdk_motion_event_finalize (GdkEvent *event)
 {
@@ -2839,6 +2899,12 @@ gdk_event_get_history (GdkEvent *event,
 
 /* {{{ GdkProximityEvent */
 
+/**
+ * GdkProximityEvent:
+ *
+ * An event related to the proximity of a tool to a device.
+ */
+
 static void
 gdk_proximity_event_finalize (GdkEvent *event)
 {
@@ -2896,6 +2962,12 @@ gdk_proximity_event_new (GdkEventType   type,
 
 /* {{{ GdkDNDEvent */
 
+/**
+ * GdkDNDEvent:
+ *
+ * An event related to drag and drop operations.
+ */
+
 static void
 gdk_dnd_event_finalize (GdkEvent *event)
 {
@@ -2996,6 +3068,12 @@ gdk_dnd_event_get_drop (GdkEvent *event)
 
 /* {{{ GdkGrabBrokenEvent */
 
+/**
+ * GdkGrabBrokenEvent:
+ *
+ * An event related to a broken windowing system grab.
+ */
+
 static const GdkEventTypeInfo gdk_grab_broken_event_info = {
   sizeof (GdkGrabBrokenEvent),
   NULL,
diff --git a/gdk/gdksurface.c b/gdk/gdksurface.c
index 393329c10f..ea6f3d5727 100644
--- a/gdk/gdksurface.c
+++ b/gdk/gdksurface.c
@@ -1356,6 +1356,12 @@ gdk_surface_layout_on_clock (GdkFrameClock *clock,
   g_signal_emit (surface, signals[LAYOUT], 0, surface->width, surface->height);
 }
 
+/**
+ * gdk_surface_request_layout:
+ * @surface: a #GdkSurface
+ *
+ * Requests a layout phase for the given @surface.
+ */
 void
 gdk_surface_request_layout (GdkSurface *surface)
 {
diff --git a/gdk/gdkversionmacros.h.in b/gdk/gdkversionmacros.h.in
index c315f33a45..3c6d6fbf05 100644
--- a/gdk/gdkversionmacros.h.in
+++ b/gdk/gdkversionmacros.h.in
@@ -24,8 +24,25 @@
 
 #include <glib.h>
 
+/**
+ * GDK_MAJOR_VERSION:
+ *
+ * The major version component of the library's version, e.g. "1" for "1.2.3".
+ */
 #define GDK_MAJOR_VERSION (@GTK_MAJOR_VERSION@)
+
+/**
+ * GDK_MINOR_VERSION:
+ *
+ * The minor version component of the library's version, e.g. "2" for "1.2.3".
+ */
 #define GDK_MINOR_VERSION (@GTK_MINOR_VERSION@)
+
+/**
+ * GDK_MICRO_VERSION:
+ *
+ * The micro version component of the library's version, e.g. "3" for "1.2.3".
+ */
 #define GDK_MICRO_VERSION (@GTK_MICRO_VERSION@)
 
 #ifndef _GDK_EXTERN
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]