summaryrefslogtreecommitdiff
path: root/src/lib/ecore/efl_promise.eo
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-20 09:41:41 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-20 09:41:46 +0000
commite942dd6420bf83c6b1d987b19a882846e81c7d01 (patch)
treeb61ac9a30c6e6b661812360dbb751a6979130e6b /src/lib/ecore/efl_promise.eo
parent26acc9bea2ac80f45f04dfe8ecced56b87670377 (diff)
Eo docs: update for grammar and readability
Diffstat (limited to '')
-rw-r--r--src/lib/ecore/efl_promise.eo30
1 files changed, 16 insertions, 14 deletions
diff --git a/src/lib/ecore/efl_promise.eo b/src/lib/ecore/efl_promise.eo
index be1a7dcd3c..bed53b393a 100644
--- a/src/lib/ecore/efl_promise.eo
+++ b/src/lib/ecore/efl_promise.eo
@@ -5,9 +5,9 @@ class Efl.Promise (Efl.Loop.Consumer)
5 [[Efl promise class]] 5 [[Efl promise class]]
6 methods { 6 methods {
7 progress_set { 7 progress_set {
8 [[Updates the progress and send it immediately to all connected Efl_Future. 8 [[Updates progress and sends it immediately to all connected Efl_Future.
9 9
10 The progress is not kept and when the function return it will not be accessed 10 The progress is not stored and when the function returns it will not be accessed
11 anymore. The pointer is owned by the caller and will remain so after the return 11 anymore. The pointer is owned by the caller and will remain so after the return
12 of the function call. 12 of the function call.
13 ]] 13 ]]
@@ -18,23 +18,24 @@ class Efl.Promise (Efl.Loop.Consumer)
18 @property future { 18 @property future {
19 [[Requests a new future linked to this promise. 19 [[Requests a new future linked to this promise.
20 20
21 Efl_Future are optional and will be automatically deleted if no then callback have 21 Efl_Future are optional and will be automatically deleted if no callbacks have
22 been set before the next iteration of the main loop. 22 been set before the next iteration of the main loop.
23 ]] 23 ]]
24 get { 24 get {
25 [[The returned new future.]] 25 [[The returned new future.]]
26 } 26 }
27 values { 27 values {
28 f: future<void_ptr, void_ptr>; [[Returns a future where the value will be set by calling value_set while the progress will be updated by progress_set.]] 28 f: future<void_ptr, void_ptr>; [[Returns a future where the value will be set by calling value_set whilst the progress is
29 updated by progress_set.]]
29 } 30 }
30 } 31 }
31 @property value { 32 @property value {
32 [[The value expected by all connected future.]] 33 [[The value expected by all connected future.]]
33 set { 34 set {
34 [[ 35 [[
35 This function can be called only once and you can not call #failed.set after that. 36 This function can be called only once. You cannot call #failed.set after doing so.
36 The value will be owned by the promise until it is destroyed. The value will be cleaned 37 The value will be owned by the promise until it's destroyed. It will be cleaned
37 when the promise and all the future depending on it are destroyed. 38 when the promise and all futures depending on it are destroyed.
38 ]] 39 ]]
39 } 40 }
40 values { 41 values {
@@ -46,7 +47,7 @@ class Efl.Promise (Efl.Loop.Consumer)
46 [[Defines the failure state of this promise.]] 47 [[Defines the failure state of this promise.]]
47 set { 48 set {
48 [[ 49 [[
49 This function can be called only once and you can not call #value.set after that. 50 This function can be called only once and you cannot call #value.set after doing so.
50 ]] 51 ]]
51 } 52 }
52 values { 53 values {
@@ -57,18 +58,19 @@ class Efl.Promise (Efl.Loop.Consumer)
57 [[Connects a future output to this promise. 58 [[Connects a future output to this promise.
58 59
59 This helper will automatically trigger #value.set or #failed.set when the future 60 This helper will automatically trigger #value.set or #failed.set when the future
60 succeed or fail respectively with the value provided by the future. 61 succeeds or fails respectively, with the value provided by the future.
61 ]] 62 ]]
62 params { 63 params {
63 @in f: future<void_ptr, void_ptr>; [[The future to connect this promise to.]] 64 @in f: future<void_ptr, void_ptr>; [[The future to connect to this promise.]]
64 } 65 }
65 return: bool; [[Returns $false if unable to setup the connection.]] 66 return: bool; [[Returns $false if unable to set up the connection.]]
66 } 67 }
67 } 68 }
68 events { 69 events {
69 future,set: future<void_ptr>; [[This event is triggered whenever a future is fully set to receive all events and that the user of it do not hold any more reference on it.]] 70 future,set: future<void_ptr>; [[This event is triggered whenever a future is fully set to receive all events and the user
70 future,progress,set: future<void_ptr>; [[This event is triggered whenever a future has a progress callback registered and the user does not hold any more reference on it.]] 71 holds no more references to it.]]
71 future,none; [[This event is triggered whenever there is no more future connected to the promise.]] 72 future,progress,set: future<void_ptr>; [[This event is triggered whenever a future has a progress callback registered and the user holds no more reference to it.]]
73 future,none; [[This event is triggered whenever there are no more futures connected to the promise.]]
72 } 74 }
73 implements { 75 implements {
74 Efl.Object.destructor; 76 Efl.Object.destructor;