summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-03-29 09:30:44 +0000
committerMarcel Hollerbach <mail@marcel-hollerbach.de>2019-03-29 12:35:50 +0100
commit01fccf6a8731424d2c0148622764e0f976b93fad (patch)
tree1bf9c39254cb8597b0f2c49e4064b49a0d109979
parent1ad9b246c074279ca34b8594949990cead36f9cd (diff)
downloadefl-01fccf6a8731424d2c0148622764e0f976b93fad.tar.gz
docs: Clarify Efl.Ui.Win exit_on_close methods
exit_on_close and exit_on_all_windows_closed deserve a bit of clarification since they have very similar meanings. Also, add proper Eina.Value doc references. Ref T7717 Reviewed-by: Marcel Hollerbach <mail@marcel-hollerbach.de> Differential Revision: https://phab.enlightenment.org/D8511
-rw-r--r--src/lib/elementary/efl_ui_win.eo11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo
index e9d572c804..3d86408942 100644
--- a/src/lib/elementary/efl_ui_win.eo
+++ b/src/lib/elementary/efl_ui_win.eo
@@ -279,8 +279,11 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
When set, the window's loop object will exit using the passed exit code if the
window is closed.
- The Eina.Value passed should be $EMPTY to unset this state or an int value to be
+ The @Eina.Value passed should be $EMPTY to unset this state or an int value to be
used as the exit code.
+
+ Note this is different from @.exit_on_all_windows_closed which exits when ALL
+ windows are closed.
]]
values {
exit_code: const(any_value_ptr); [[The exit code to use when exiting]]
@@ -610,11 +613,13 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
When set, the main loop will quit with the passed exit code once all windows have been closed.
- The Eina.Value passed should be $EMPTY to unset this state or an int value to be
+ The @Eina.Value passed should be $EMPTY to unset this state or an int value to be
used as the exit code.
+
+ Note this is different from @.exit_on_close which exits when a given window is closed.
]]
values {
- exit_code: const(any_value_ptr); [[The exit code to use when exiting]]
+ exit_code: const(any_value_ptr); [[The exit code to use when exiting.]]
}
}
activate {