AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

gdk: Documentation touchups

Browse Source 
Minor rewordings here and there, strip nonpublic
functions of doc comments, deemphasize logical/physical
devices.
This commit is contained in:
Matthias Clasen 2020-08-13 20:59:04 -04:00
parent 97e0f1108d
commit 22ac6d3148
2 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
gdk/gdkdevice.c
View File

@ -35,9 +35,8 @@
* The #GdkDevice object represents a single input device, such * The #GdkDevice object represents a single input device, such
* as a keyboard, a mouse, a touchpad, etc. * as a keyboard, a mouse, a touchpad, etc.
* *
* See the #GdkSeat documentation for more information * See the #GdkSeat documentation for more information about the
* about the various kinds of logical and physical devices, and their * various kinds of devices, and their relationships.
* relationships.
*/ */
/** /**
@ -536,7 +535,8 @@ gdk_device_get_surface_at_position (GdkDevice *device,
* gdk_device_get_name: * gdk_device_get_name:
* @device: a #GdkDevice * @device: a #GdkDevice
* *
* Determines the name of the device. * Determines the name of the device, suitable
* for showing in a user interface.
* *
* Returns: a name * Returns: a name
**/ **/
@ -553,7 +553,8 @@ gdk_device_get_name (GdkDevice *device)
* @device: a #GdkDevice * @device: a #GdkDevice
* *
* Determines whether the pointer follows device motion. * Determines whether the pointer follows device motion.
* This is not meaningful for keyboard devices, which don't have a pointer. * This is not meaningful for keyboard devices, which
* don't have a pointer.
* *
* Returns: %TRUE if the pointer follows device motion * Returns: %TRUE if the pointer follows device motion
**/ **/
@ -642,7 +643,7 @@ _gdk_device_set_associated_device (GdkDevice *device,
device->associated = g_object_ref (associated); device->associated = g_object_ref (associated);
} }
/** /*
* gdk_device_list_physical_devices: * gdk_device_list_physical_devices:
* @device: a logical #GdkDevice * @device: a logical #GdkDevice
* *
@ -681,7 +682,7 @@ _gdk_device_remove_physical_device (GdkDevice *device,
device->physical_devices = g_list_delete_link (device->physical_devices, elem); device->physical_devices = g_list_delete_link (device->physical_devices, elem);
} }
/** /*
* gdk_device_get_n_axes: * gdk_device_get_n_axes:
* @device: a pointer #GdkDevice * @device: a pointer #GdkDevice
* *
@ -698,7 +699,7 @@ gdk_device_get_n_axes (GdkDevice *device)
return device->axes->len; return device->axes->len;
} }
/** /*
* gdk_device_get_axis: (skip) * gdk_device_get_axis: (skip)
* @device: a #GdkDevice * @device: a #GdkDevice
* @axes: (array): pointer to an array of axes * @axes: (array): pointer to an array of axes
@ -1194,8 +1195,7 @@ gdk_device_set_seat (GdkDevice *device,
* *
* Returns the #GdkSeat the device belongs to. * Returns the #GdkSeat the device belongs to.
* *
* Returns: (transfer none): A #GdkSeat. This memory is owned by GTK+ and * Returns: (transfer none): a #GdkSeat
* must not be freed.
**/ **/
GdkSeat * GdkSeat *
gdk_device_get_seat (GdkDevice *device) gdk_device_get_seat (GdkDevice *device)

18
gdk/gdkseat.c
View File

@ -232,7 +232,7 @@ gdk_seat_get_capabilities (GdkSeat *seat)
return seat_class->get_capabilities (seat); return seat_class->get_capabilities (seat);
} }
/** /*
* gdk_seat_grab: * gdk_seat_grab:
* @seat: a #GdkSeat * @seat: a #GdkSeat
* @surface: the #GdkSurface which will own the grab * @surface: the #GdkSurface which will own the grab
@ -306,7 +306,7 @@ gdk_seat_grab (GdkSeat *seat,
event, prepare_func, prepare_func_data); event, prepare_func, prepare_func_data);
} }
/** /*
* gdk_seat_ungrab: * gdk_seat_ungrab:
* @seat: a #GdkSeat * @seat: a #GdkSeat
* *
@ -332,7 +332,7 @@ gdk_seat_ungrab (GdkSeat *seat)
* *
* Returns: (transfer container) (element-type GdkDevice): A list of #GdkDevices. * Returns: (transfer container) (element-type GdkDevice): A list of #GdkDevices.
* The list must be freed with g_list_free(), the elements are owned * The list must be freed with g_list_free(), the elements are owned
* by GDK and must not be freed. * by GTK and must not be freed.
**/ **/
GList * GList *
gdk_seat_get_devices (GdkSeat *seat, gdk_seat_get_devices (GdkSeat *seat,
@ -350,9 +350,9 @@ gdk_seat_get_devices (GdkSeat *seat,
* gdk_seat_get_pointer: * gdk_seat_get_pointer:
* @seat: a #GdkSeat * @seat: a #GdkSeat
* *
* Returns the logical device that routes pointer events. * Returns the device that routes pointer events.
* *
* Returns: (transfer none) (nullable): a logical #GdkDevice with pointer * Returns: (transfer none) (nullable): a #GdkDevice with pointer
* capabilities. This object is owned by GTK and must not be freed. * capabilities. This object is owned by GTK and must not be freed.
**/ **/
GdkDevice * GdkDevice *
@ -370,9 +370,9 @@ gdk_seat_get_pointer (GdkSeat *seat)
* gdk_seat_get_keyboard: * gdk_seat_get_keyboard:
* @seat: a #GdkSeat * @seat: a #GdkSeat
* *
* Returns the logical device that routes keyboard events. * Returns the device that routes keyboard events.
* *
* Returns: (transfer none) (nullable): a logical #GdkDevice with keyboard * Returns: (transfer none) (nullable): a #GdkDevice with keyboard
* capabilities. This object is owned by GTK and must not be freed. * capabilities. This object is owned by GTK and must not be freed.
**/ **/
GdkDevice * GdkDevice *
@ -468,8 +468,8 @@ gdk_seat_get_tool (GdkSeat *seat,
* Returns all #GdkDeviceTools that are known to the * Returns all #GdkDeviceTools that are known to the
* application. * application.
* *
* Returns: (transfer container) (element-type Gdk.DeviceTool): A list of tools. Free with * Returns: (transfer container) (element-type Gdk.DeviceTool):
* g_list_free(). * A list of tools. Free with g_list_free().
**/ **/
GList * GList *
gdk_seat_get_tools (GdkSeat *seat) gdk_seat_get_tools (GdkSeat *seat)