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
This commit is contained in:
Xavi Artigas 2019-03-29 09:30:44 +00:00 committed by Marcel Hollerbach
parent 1ad9b246c0
commit 01fccf6a87
1 changed files with 8 additions and 3 deletions

View File

@ -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 When set, the window's loop object will exit using the passed exit code if the
window is closed. 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. used as the exit code.
Note this is different from @.exit_on_all_windows_closed which exits when ALL
windows are closed.
]] ]]
values { 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]]
@ -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. 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. used as the exit code.
Note this is different from @.exit_on_close which exits when a given window is closed.
]] ]]
values { 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 { activate {