Commit 76063296 authored by Matthias Clasen's avatar Matthias Clasen Committed by Emmanuele Bassi
Browse files

gesturezoom: Convert docs

parent 7a1da45f
...@@ -19,15 +19,13 @@ ...@@ -19,15 +19,13 @@
*/ */
/** /**
* SECTION:gtkgesturezoom * GtkGestureZoom:
* @Short_description: Zoom gesture
* @Title: GtkGestureZoom
* @See_also: #GtkGestureRotate
* *
* #GtkGestureZoom is a #GtkGesture implementation able to recognize * `GtkGestureZoom` is a `GtkGesture` for 2-finger pinch/zoom gestures.
* pinch/zoom gestures, whenever the distance between both tracked *
* sequences changes, the #GtkGestureZoom::scale-changed signal is * Whenever the distance between both tracked sequences changes, the
* emitted to report the scale factor. * [signal@Gtk.GestureZoom::scale-changed] signal is emitted to report
* the scale factor.
*/ */
#include "config.h" #include "config.h"
...@@ -204,8 +202,7 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass) ...@@ -204,8 +202,7 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass)
* @controller: the object on which the signal is emitted * @controller: the object on which the signal is emitted
* @scale: Scale delta, taking the initial state as 1:1 * @scale: Scale delta, taking the initial state as 1:1
* *
* This signal is emitted whenever the distance between both tracked * Emitted whenever the distance between both tracked sequences changes.
* sequences changes.
*/ */
signals[SCALE_CHANGED] = signals[SCALE_CHANGED] =
g_signal_new (I_("scale-changed"), g_signal_new (I_("scale-changed"),
...@@ -219,11 +216,11 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass) ...@@ -219,11 +216,11 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass)
/** /**
* gtk_gesture_zoom_new: * gtk_gesture_zoom_new:
* *
* Returns a newly created #GtkGesture that recognizes zoom * Returns a newly created `GtkGesture` that recognizes
* in/out gestures (usually known as pinch/zoom). * pinch/zoom gestures.
* *
* Returns: a newly created #GtkGestureZoom * Returns: a newly created `GtkGestureZoom`
**/ */
GtkGesture * GtkGesture *
gtk_gesture_zoom_new (void) gtk_gesture_zoom_new (void)
{ {
...@@ -233,14 +230,17 @@ gtk_gesture_zoom_new (void) ...@@ -233,14 +230,17 @@ gtk_gesture_zoom_new (void)
/** /**
* gtk_gesture_zoom_get_scale_delta: * gtk_gesture_zoom_get_scale_delta:
* @gesture: a #GtkGestureZoom * @gesture: a `GtkGestureZoom`
* *
* If @gesture is active, this function returns the zooming difference * Gets the scale delta.
* since the gesture was recognized (hence the starting point is *
* considered 1:1). If @gesture is not active, 1 is returned. * If @gesture is active, this function returns the zooming
* difference since the gesture was recognized (hence the
* starting point is considered 1:1). If @gesture is not
* active, 1 is returned.
* *
* Returns: the scale delta * Returns: the scale delta
**/ */
double double
gtk_gesture_zoom_get_scale_delta (GtkGestureZoom *gesture) gtk_gesture_zoom_get_scale_delta (GtkGestureZoom *gesture)
{ {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment