docs: fill in missing documentation ein efl_gesture* eo classes
authorStefan Schmidt <stefan@osg.samsung.com>
Fri, 8 Dec 2017 14:05:00 +0000 (15:05 +0100)
committerStefan Schmidt <stefan@osg.samsung.com>
Fri, 8 Dec 2017 15:17:27 +0000 (16:17 +0100)
src/lib/evas/gesture/efl_gesture.eo
src/lib/evas/gesture/efl_gesture_long_tap.eo
src/lib/evas/gesture/efl_gesture_manager.eo
src/lib/evas/gesture/efl_gesture_recognizer.eo
src/lib/evas/gesture/efl_gesture_recognizer_long_tap.eo
src/lib/evas/gesture/efl_gesture_recognizer_tap.eo
src/lib/evas/gesture/efl_gesture_tap.eo
src/lib/evas/gesture/efl_gesture_touch.eo
src/lib/evas/gesture/efl_gesture_types.eot

index 18881a7..5fd6de9 100644 (file)
@@ -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.]]
index cb2f4a9..4bb0869 100644 (file)
@@ -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]]
index 1f0bed4..52d48ec 100644 (file)
@@ -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]]
index 24001b4..6176381 100644 (file)
@@ -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]]
index 8d619a1..94b5b10 100644 (file)
@@ -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;
index f91964c..bf2ceef 100644 (file)
@@ -1,5 +1,6 @@
 class Efl.Gesture.Recognizer_Tap (Efl.Gesture.Recognizer)
 {
+   [[EFL Gesture Recognizer Tap class]]
    data: null;
    implements {
       Efl.Gesture.Recognizer.create;
index cdd51ee..993d206 100644 (file)
@@ -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]]
index a124dfc..b85d145 100644 (file)
@@ -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 {
index 0f771aa..d78d12b 100644 (file)
@@ -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]]
 }