diff options
| -rw-r--r-- | gtk/gtkeventcontroller.c | 4 | ||||
| -rw-r--r-- | gtk/gtkgesture.c | 54 | ||||
| -rw-r--r-- | gtk/gtkgesturedrag.c | 6 | ||||
| -rw-r--r-- | gtk/gtkgesturelongpress.c | 2 | ||||
| -rw-r--r-- | gtk/gtkgesturemultipress.c | 16 | ||||
| -rw-r--r-- | gtk/gtkgesturepan.c | 2 | ||||
| -rw-r--r-- | gtk/gtkgesturesingle.c | 24 | ||||
| -rw-r--r-- | gtk/gtkgestureswipe.c | 6 | ||||
| -rw-r--r-- | gtk/gtkgesturezoom.c | 2 |
9 files changed, 62 insertions, 54 deletions
diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c index a505512bce..9a137a0e5e 100644 --- a/gtk/gtkeventcontroller.c +++ b/gtk/gtkeventcontroller.c @@ -205,7 +205,7 @@ gtk_event_controller_init (GtkEventController *controller) * and the controller actions triggered. * * Returns: %TRUE if the event was potentially useful to trigger the - * controller action. + * controller action * * Since: 3.14 **/ @@ -257,7 +257,7 @@ gtk_event_controller_set_event_mask (GtkEventController *controller, * * Returns the event mask necessary for the events handled by @controller. * - * Returns: the controller event mask. + * Returns: the controller event mask * * Since: 3.14 **/ diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c index 66a8173d5c..cc5e1f7e3d 100644 --- a/gtk/gtkgesture.c +++ b/gtk/gtkgesture.c @@ -684,11 +684,11 @@ gtk_gesture_class_init (GtkGestureClass *klass) /** * GtkGesture::end: * @gesture: the object which received the signal - * @sequence: the #GdkEventSequence that made gesture recognition to finish. + * @sequence: the #GdkEventSequence that made gesture recognition to finish * * This signal is emitted when @gesture either stopped recognizing the event * sequences as something to be handled (the #GtkGesture::check handler returned - * #FALSE), or the number of touch sequences became higher or lower than + * %FALSE), or the number of touch sequences became higher or lower than * #GtkGesture:n-points. * * Note: @sequence might not pertain to the group of sequences that were @@ -708,7 +708,7 @@ gtk_gesture_class_init (GtkGestureClass *klass) /** * GtkGesture::update: * @gesture: the object which received the signal - * @sequence: the #GdkEventSequence that was updated. + * @sequence: the #GdkEventSequence that was updated * * This signal is emitted whenever an event is handled while the gesture is * recognized. @sequence is guaranteed to pertain to the set of active touches. @@ -725,7 +725,7 @@ gtk_gesture_class_init (GtkGestureClass *klass) /** * GtkGesture::cancel: * @gesture: the object which received the signal - * @sequence: the #GdkEventSequence that was cancelled. + * @sequence: the #GdkEventSequence that was cancelled * * This signal is emitted whenever a sequence is cancelled. This usually * happens on active touches when gtk_event_controller_reset() is called @@ -746,7 +746,7 @@ gtk_gesture_class_init (GtkGestureClass *klass) /** * GtkGesture::sequence-state-changed: * @gesture: the object which received the signal - * @sequence: the #GdkEventSequence that was cancelled. + * @sequence: the #GdkEventSequence that was cancelled * @state: the new sequence state * * This signal is emitted whenever a sequence state changes. See @@ -786,7 +786,7 @@ gtk_gesture_init (GtkGesture *gesture) * Returns the master #GdkDevice that is currently operating * on @gesture, or %NULL if the gesture is not being interacted. * - * Returns: a #GdkDevice, or %NULL. + * Returns: a #GdkDevice, or %NULL * * Since: 3.14 **/ @@ -809,7 +809,7 @@ gtk_gesture_get_device (GtkGesture *gesture) * * Returns the @sequence state, as seen by @gesture. * - * Returns: The sequence state in @gesture. + * Returns: The sequence state in @gesture * * Since: 3.14 **/ @@ -850,8 +850,8 @@ gtk_gesture_get_sequence_state (GtkGesture *gesture, * * None → Claimed * * None → Claimed → Denied * - * Returns: #TRUE if @sequence is handled by @gesture, - * and the state is changed successfully. + * Returns: %TRUE if @sequence is handled by @gesture, + * and the state is changed successfully * * Since: 3.14 **/ @@ -905,7 +905,7 @@ gtk_gesture_set_sequence_state (GtkGesture *gesture, * for more details on sequence states. * * Returns: %TRUE if the state of at least one sequence - * was changed successfully. + * was changed successfully * * Since: 3.14 */ @@ -937,12 +937,14 @@ gtk_gesture_set_state (GtkGesture *gesture, * @gesture: a #GtkGesture * * Returns the list of #GdkEventSequences currently being interpreted - * by @gesture + * by @gesture. * * Returns: (transfer container) (element-type GdkEventSequence): A list * of #GdkEventSequences, the list elements are owned by GTK+ * and must not be freed or modified, the list itself must be deleted * through g_list_free() + * + * Since: 3.14 **/ GList * gtk_gesture_get_sequences (GtkGesture *gesture) @@ -978,7 +980,7 @@ gtk_gesture_get_sequences (GtkGesture *gesture) * * Returns the #GdkEventSequence that was last updated on @gesture. * - * Returns: The last updated sequence. + * Returns: The last updated sequence * * Since: 3.14 **/ @@ -1090,11 +1092,11 @@ _gtk_gesture_get_last_update_time (GtkGesture *gesture, * @rect: (out): bounding box containing all active touches. * * If there are touch sequences being currently handled by @gesture, - * this function returns #TRUE and fills in @rect with the bounding - * box containing all active touches. Otherwise, #FALSE will be + * this function returns %TRUE and fills in @rect with the bounding + * box containing all active touches. Otherwise, %FALSE will be * returned. * - * Returns: #TRUE if there are active touches, #FALSE otherwise + * Returns: %TRUE if there are active touches, %FALSE otherwise * * Since: 3.14 **/ @@ -1154,11 +1156,11 @@ gtk_gesture_get_bounding_box (GtkGesture *gesture, * @y: (out): Y coordinate for the bounding box center * * If there are touch sequences being currently handled by @gesture, - * this function returns #TRUE and fills in @x and @y with the center - * of the bounding box containing all active touches. Otherwise, #FALSE + * this function returns %TRUE and fills in @x and @y with the center + * of the bounding box containing all active touches. Otherwise, %FALSE * will be returned. * - * Returns: #FALSE if no active touches are present, #TRUE otherwise + * Returns: %FALSE if no active touches are present, %TRUE otherwise * * Since: 3.14 **/ @@ -1188,7 +1190,7 @@ gtk_gesture_get_bounding_box_center (GtkGesture *gesture, * A gesture is active meanwhile there are touch sequences * interacting with it. * - * Returns: %TRUE if gesture is active. + * Returns: %TRUE if gesture is active * * Since: 3.14 **/ @@ -1207,9 +1209,9 @@ gtk_gesture_is_active (GtkGesture *gesture) * Returns %TRUE if the gesture is currently recognized. * A gesture is recognized if there are as many interacting * touch sequences as required by @gesture, and #GtkGesture::check - * returned #TRUE for the sequences being currently interpreted. + * returned %TRUE for the sequences being currently interpreted. * - * Returns: %TRUE if gesture is recognized. + * Returns: %TRUE if gesture is recognized * * Since: 3.14 **/ @@ -1242,10 +1244,10 @@ _gtk_gesture_check (GtkGesture *gesture) * @gesture: a #GtkGesture * @sequence: a #GdkEventSequence * - * Returns #TRUE if @gesture is currently handling events corresponding to + * Returns %TRUE if @gesture is currently handling events corresponding to * @sequence. * - * Returns: #TRUE if @gesture is handling @sequence. + * Returns: %TRUE if @gesture is handling @sequence * * Since: 3.14 **/ @@ -1299,7 +1301,7 @@ _gtk_gesture_cancel_sequence (GtkGesture *gesture, * handled by @gesture. See gtk_gesture_set_window() for more * information. * - * Returns: the user defined window, or %NULL if none. + * Returns: the user defined window, or %NULL if none * * Since: 3.14 **/ @@ -1448,7 +1450,7 @@ gtk_gesture_ungroup (GtkGesture *gesture) * Returns all gestures in the group of @gesture * * Returns: (element-type GtkGesture) (transfer container): The list - * of #GtkGestures, free with g_list_free(). + * of #GtkGestures, free with g_list_free() * * Since: 3.14 **/ @@ -1469,7 +1471,7 @@ gtk_gesture_get_group (GtkGesture *gesture) * @gesture: a #GtkGesture * @other: another #GtkGesture * - * Returns #TRUE if both gestures pertain to the same group. + * Returns %TRUE if both gestures pertain to the same group. * * Returns: whether the gestures are grouped * diff --git a/gtk/gtkgesturedrag.c b/gtk/gtkgesturedrag.c index 141362ad75..3f8f1e1d71 100644 --- a/gtk/gtkgesturedrag.c +++ b/gtk/gtkgesturedrag.c @@ -177,7 +177,7 @@ gtk_gesture_drag_init (GtkGestureDrag *gesture) * gtk_gesture_drag_new: * @widget: a #GtkWidget * - * Returns a newly created #GtkGesture that recognizes drags + * Returns a newly created #GtkGesture that recognizes drags. * * Returns: a newly created #GtkGestureDrag * @@ -201,7 +201,7 @@ gtk_gesture_drag_new (GtkWidget *widget) * and fills in @x and @y with the drag start coordinates, * in window-relative coordinates. * - * Returns: #TRUE if the gesture is active. + * Returns: %TRUE if the gesture is active * * Since: 3.14 **/ @@ -241,7 +241,7 @@ gtk_gesture_drag_get_start_point (GtkGestureDrag *gesture, * fills in @x and @y with the coordinates of the current point, * as an offset to the starting drag point. * - * Returns: #TRUE if the gesture is active. + * Returns: %TRUE if the gesture is active * * Since: 3.14 **/ diff --git a/gtk/gtkgesturelongpress.c b/gtk/gtkgesturelongpress.c index 940575f16d..61e18d1c14 100644 --- a/gtk/gtkgesturelongpress.c +++ b/gtk/gtkgesturelongpress.c @@ -253,7 +253,7 @@ gtk_gesture_long_press_class_init (GtkGestureLongPressClass *klass) * gtk_gesture_long_press_new: * @widget: a #GtkWidget * - * Returns a newly created #GtkGesture that recognizes long presses + * Returns a newly created #GtkGesture that recognizes long presses. * * Returns: a newly created #GtkGestureLongPress * diff --git a/gtk/gtkgesturemultipress.c b/gtk/gtkgesturemultipress.c index 5c531c4e51..3fbe20f5f6 100644 --- a/gtk/gtkgesturemultipress.c +++ b/gtk/gtkgesturemultipress.c @@ -24,9 +24,9 @@ * * #GtkGestureMultiPress is a #GtkGesture implementation able to recognize * multiple clicks on a nearby zone, which can be listened for through the - * #GtkGestureMultiPress::pressed signal. Whenever time or distance between clicks - * exceed the GTK+ defaults, #GtkGestureMultiPress::stopped is emitted, and the - * click counter is reset. + * #GtkGestureMultiPress::pressed signal. Whenever time or distance between + * clicks exceed the GTK+ defaults, #GtkGestureMultiPress::stopped is emitted, + * and the click counter is reset. * * Callers may also restrict the area that is considered valid for a >1 * touch/button press through gtk_gesture_multi_press_set_area(), so any @@ -392,9 +392,9 @@ gtk_gesture_multi_press_new (GtkWidget *widget) /** * gtk_gesture_multi_press_set_area: * @gesture: a #GtkGesture - * @rect: (allow-none): rectangle to receive coordinates on. + * @rect: (allow-none): rectangle to receive coordinates on * - * If @rect is non-#NULL, the press area will be checked to be + * If @rect is non-%NULL, the press area will be checked to be * confined within the rectangle, otherwise the button count * will be reset so the press is seen as being the first one. * If @rect is #NULL, the area will be reset to an unrestricted @@ -432,11 +432,13 @@ gtk_gesture_multi_press_set_area (GtkGestureMultiPress *gesture, * @rect: (out): return location for the press area * * If an area was set through gtk_gesture_multi_press_set_area(), - * this function will return #TRUE and fill in @rect with the + * this function will return %TRUE and fill in @rect with the * press area. See gtk_gesture_multi_press_set_area() for more * details on what the press area represents. * - * Returns: 3.14 + * Returns: %TRUE if @rect was filled with the press area + * + * Since: 3.14 **/ gboolean gtk_gesture_multi_press_get_area (GtkGestureMultiPress *gesture, diff --git a/gtk/gtkgesturepan.c b/gtk/gtkgesturepan.c index 660f3d9b31..a7c2936e1b 100644 --- a/gtk/gtkgesturepan.c +++ b/gtk/gtkgesturepan.c @@ -298,7 +298,7 @@ gtk_gesture_pan_new (GtkWidget *widget, * * Returns the orientation of the pan gestures that this @gesture expects. * - * Return value: the expected orientation for pan gestures. + * Return value: the expected orientation for pan gestures * * Since: 3.14 */ diff --git a/gtk/gtkgesturesingle.c b/gtk/gtkgesturesingle.c index 4941c5e638..58010dc444 100644 --- a/gtk/gtkgesturesingle.c +++ b/gtk/gtkgesturesingle.c @@ -20,7 +20,7 @@ /** * SECTION:gtkgesturesingle - * @Short_description: Base class for for mouse/single-touch gestures + * @Short_description: Base class for for mouse/single-touch gestures * @Title: GtkGestureSingle * * #GtkGestureSingle is a subclass of #GtkGesture, optimized (although @@ -226,7 +226,7 @@ gtk_gesture_single_class_init (GtkGestureSingleClass *klass) /** * GtkGestureSingle:touch-only: * - * Whether the gesture handles only touch events + * Whether the gesture handles only touch events. * * Since: 3.14 */ @@ -304,9 +304,9 @@ gtk_gesture_single_init (GtkGestureSingle *gesture) * gtk_gesture_single_get_touch_only: * @gesture: a #GtkGestureSingle * - * Returns #TRUE if the gesture is only triggered by touch events. + * Returns %TRUE if the gesture is only triggered by touch events. * - * Returns: #TRUE if the gesture only handles touch events. + * Returns: %TRUE if the gesture only handles touch events * * Since: 3.14 **/ @@ -327,8 +327,8 @@ gtk_gesture_single_get_touch_only (GtkGestureSingle *gesture) * @gesture: a #GtkGestureSingle * @touch_only: whether @gesture handles only touch events * - * If @touch_only is #TRUE, @gesture will only handle events of type - * #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If #FALSE, + * If @touch_only is %TRUE, @gesture will only handle events of type + * #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If %FALSE, * mouse events will be handled too. * * Since: 3.14 @@ -378,7 +378,7 @@ gtk_gesture_single_get_exclusive (GtkGestureSingle *gesture) /** * gtk_gesture_single_set_exclusive: * @gesture: a #GtkGestureSingle - * @exclusive: #TRUE to make @gesture exclusive + * @exclusive: %TRUE to make @gesture exclusive * * Sets whether @gesture is exclusive. An exclusive gesture will * only handle pointer and "pointer emulated" touch events, so at @@ -413,7 +413,7 @@ gtk_gesture_single_set_exclusive (GtkGestureSingle *gesture, * Returns the button number @gesture listens for, or 0 if @gesture * reacts to any button press. * - * Returns: The button number, or 0 for any button. + * Returns: The button number, or 0 for any button * * Since: 3.14 **/ @@ -465,6 +465,8 @@ gtk_gesture_single_set_button (GtkGestureSingle *gesture, * is none. * * Returns: The current button number + * + * Since: 3.14 **/ guint gtk_gesture_single_get_current_button (GtkGestureSingle *gesture) @@ -482,10 +484,12 @@ gtk_gesture_single_get_current_button (GtkGestureSingle *gesture) * gtk_gesture_single_get_current_sequence: * @gesture: a #GtkGestureSingle * - * Returns the event sequence currently interacting with @gesture, - * this is only meaningful if gtk_gesture_is_active() returns #TRUE. + * Returns the event sequence currently interacting with @gesture. + * This is only meaningful if gtk_gesture_is_active() returns %TRUE. * * Returns: the current sequence + * + * Since: 3.14 **/ GdkEventSequence * gtk_gesture_single_get_current_sequence (GtkGestureSingle *gesture) diff --git a/gtk/gtkgestureswipe.c b/gtk/gtkgestureswipe.c index 310767599a..1502f765f8 100644 --- a/gtk/gtkgestureswipe.c +++ b/gtk/gtkgestureswipe.c @@ -25,14 +25,14 @@ * * #GtkGestureSwipe is a #GtkGesture implementation able to recognize * swipes, after a press/move/.../move/release sequence happens, the - * GtkGestureSwipe:swipe signal will be emitted, providing the velocity + * #GtkGestureSwipe::swipe signal will be emitted, providing the velocity * and directionality of the sequence at the time it was lifted. * * If the velocity is desired in intermediate points, * gtk_gesture_swipe_get_velocity() can be called on eg. a * #GtkGesture::update handler. * - * All velocities are reported in pixels/sec values. + * All velocities are reported in pixels/sec units. */ #include "config.h" @@ -228,7 +228,7 @@ gtk_gesture_swipe_init (GtkGestureSwipe *gesture) * gtk_gesture_swipe_new: * @widget: a #GtkWidget * - * Returns a newly created #GtkGesture that recognizes swipes + * Returns a newly created #GtkGesture that recognizes swipes. * * Returns: a newly created #GtkGestureSwipe * diff --git a/gtk/gtkgesturezoom.c b/gtk/gtkgesturezoom.c index a300366a36..75d6a76e4b 100644 --- a/gtk/gtkgesturezoom.c +++ b/gtk/gtkgesturezoom.c @@ -172,7 +172,7 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass) * @widget: a #GtkWidget * * Returns a newly created #GtkGesture that recognizes zoom - * in/out gestures (usually known as pinch/zoom) + * in/out gestures (usually known as pinch/zoom). * * Returns: a newly created #GtkGestureZoom * |