docs: Clarify Efl.Ui.Win exit_on_close methods
authorXavi Artigas <xavierartigas@yahoo.es>
Fri, 29 Mar 2019 09:30:44 +0000 (09:30 +0000)
committerJunsuChoi <jsuya.choi@samsung.com>
Tue, 2 Apr 2019 04:21:10 +0000 (13:21 +0900)
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

src/lib/elementary/efl_ui_win.eo

index f4c4247..37097fe 100644 (file)
@@ -318,8 +318,11 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
            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]]
@@ -649,11 +652,13 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
 
            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 {