stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=2ed70844568e26adf41a47eecc7d5feb7e7897e8
commit 2ed70844568e26adf41a47eecc7d5feb7e7897e8
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Fri Dec 8 15:05:00 2017 +0100
docs: fill in missing documentation ein efl_gesture* eo classes
---
src/lib/evas/gesture/efl_gesture.eo | 1 +
src/lib/evas/gesture/efl_gesture_long_tap.eo | 1 +
src/lib/evas/gesture/efl_gesture_manager.eo | 1 +
src/lib/evas/gesture/efl_gesture_recognizer.eo | 1 +
src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo | 1 +
src/lib/evas/gesture/efl_gesture_recognizer_tap.eo | 1 +
src/lib/evas/gesture/efl_gesture_tap.eo | 1 +
src/lib/evas/gesture/efl_gesture_touch.eo | 4 +++-
src/lib/evas/gesture/efl_gesture_types.eot | 4 ++--
9 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/src/lib/evas/gesture/efl_gesture.eo
b/src/lib/evas/gesture/efl_gesture.eo
index 18881a7471..5fd6de9913 100644
--- a/src/lib/evas/gesture/efl_gesture.eo
+++ b/src/lib/evas/gesture/efl_gesture.eo
@@ -2,6 +2,7 @@ import efl_gesture_types;
abstract Efl.Gesture(Efl.Object)
{
+ [[EFL Gesture abstract class]]
methods {
@property type {
[[This property holds the type of the gesture.]]
diff --git a/src/lib/evas/gesture/efl_gesture_long_tap.eo
b/src/lib/evas/gesture/efl_gesture_long_tap.eo
index cb2f4a908f..4bb0869bcc 100644
--- a/src/lib/evas/gesture/efl_gesture_long_tap.eo
+++ b/src/lib/evas/gesture/efl_gesture_long_tap.eo
@@ -2,6 +2,7 @@ import efl_gesture_types;
class Efl.Gesture.Long_Tap (Efl.Gesture)
{
+ [[EFL Gesture Long Tap class]]
event_prefix: efl;
events {
gesture,long_tap; [[Event for tap gesture]]
diff --git a/src/lib/evas/gesture/efl_gesture_manager.eo
b/src/lib/evas/gesture/efl_gesture_manager.eo
index 1f0bed434b..52d48ec0af 100644
--- a/src/lib/evas/gesture/efl_gesture_manager.eo
+++ b/src/lib/evas/gesture/efl_gesture_manager.eo
@@ -2,6 +2,7 @@ import efl_gesture_types;
class Efl.Gesture.Manager (Efl.Object)
{
+ [[EFL Gesture Manager class]]
methods {
recognizer_register {
[[This function is called to register a new Efl.Gesture.Recognizer]]
diff --git a/src/lib/evas/gesture/efl_gesture_recognizer.eo
b/src/lib/evas/gesture/efl_gesture_recognizer.eo
index 24001b4d0c..617638147e 100644
--- a/src/lib/evas/gesture/efl_gesture_recognizer.eo
+++ b/src/lib/evas/gesture/efl_gesture_recognizer.eo
@@ -2,6 +2,7 @@ import efl_gesture_types;
abstract Efl.Gesture.Recognizer (Efl.Object)
{
+ [[EFL Gesture Recognizer abstract class]]
methods {
create @pure_virtual {
[[This function is called to create a new Efl.Gesture object for the
given target]]
diff --git a/src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo
b/src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo
index 8d619a163d..94b5b10913 100644
--- a/src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo
+++ b/src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo
@@ -1,5 +1,6 @@
class Efl.Gesture.Recognizer_Long_Tap (Efl.Gesture.Recognizer)
{
+ [[EFL Gesture Recognizer Long Tap class]]
data: null;
implements {
Efl.Gesture.Recognizer.create;
diff --git a/src/lib/evas/gesture/efl_gesture_recognizer_tap.eo
b/src/lib/evas/gesture/efl_gesture_recognizer_tap.eo
index f91964c55a..bf2ceef326 100644
--- a/src/lib/evas/gesture/efl_gesture_recognizer_tap.eo
+++ b/src/lib/evas/gesture/efl_gesture_recognizer_tap.eo
@@ -1,5 +1,6 @@
class Efl.Gesture.Recognizer_Tap (Efl.Gesture.Recognizer)
{
+ [[EFL Gesture Recognizer Tap class]]
data: null;
implements {
Efl.Gesture.Recognizer.create;
diff --git a/src/lib/evas/gesture/efl_gesture_tap.eo
b/src/lib/evas/gesture/efl_gesture_tap.eo
index cdd51ee7a2..993d2067c1 100644
--- a/src/lib/evas/gesture/efl_gesture_tap.eo
+++ b/src/lib/evas/gesture/efl_gesture_tap.eo
@@ -2,6 +2,7 @@ import efl_gesture_types;
class Efl.Gesture.Tap(Efl.Gesture)
{
+ [[EFL Gesture Tap class]]
event_prefix: efl;
events {
gesture,tap; [[Event for tap gesture]]
diff --git a/src/lib/evas/gesture/efl_gesture_touch.eo
b/src/lib/evas/gesture/efl_gesture_touch.eo
index a124dfcc69..b85d14599c 100644
--- a/src/lib/evas/gesture/efl_gesture_touch.eo
+++ b/src/lib/evas/gesture/efl_gesture_touch.eo
@@ -5,8 +5,10 @@ import efl_input_types;
class Efl.Gesture.Touch(Efl.Object)
{
+ [[EFL Gesture Touch class]]
methods {
point_record {
+ [[Touch point record method]]
params {
@in tool : int; [[The finger id ]]
@in pos : Eina.Vector2; [[Position of the event]]
@@ -39,7 +41,7 @@ class Efl.Gesture.Touch(Efl.Object)
@property multi_touch {
[[This property tells if the event is multi touch.]]
get {
- return: bool; [[returns true if its a multi touch]]
+ return: bool; [[returns $true if its a multi touch]]
}
}
@property state {
diff --git a/src/lib/evas/gesture/efl_gesture_types.eot
b/src/lib/evas/gesture/efl_gesture_types.eot
index 0f771aa5e8..d78d12ba21 100644
--- a/src/lib/evas/gesture/efl_gesture_types.eot
+++ b/src/lib/evas/gesture/efl_gesture_types.eot
@@ -12,7 +12,7 @@ enum Efl.Gesture.State
{
[[ This enum type describes the state of a gesture. ]]
legacy: efl_gesture;
- none = 0,
+ none = 0, [[No gesture state]]
started = 1, [[A continuous gesture has started.]]
updated, [[A gesture continues.]]
finished, [[A gesture has finished.]]
@@ -29,5 +29,5 @@ enum Efl.Gesture.Recognizer_Result
trigger = 0x0004, [[The gesture has been triggered]]
finish = 0x0008, [[The gesture has been finished successfully.]]
cancel = 0x0010, [[The event made it clear that it is not a gesture. If
the gesture recognizer was in Triggered state before, then the gesture is
canceled.]]
- result_mask = 0x00ff,
+ result_mask = 0x00ff, [[The gesture result mask]]
}
--
