summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno da Silva Belo <brunodasilvabelo@gmail.com>2019-10-14 00:53:34 -0300
committerLauro Moura <lauromoura@expertisesolutions.com.br>2019-10-14 00:59:20 -0300
commit09744f6c289a09f0c6533ad9b54964f004bf4666 (patch)
tree1156a750937676cad7c1702266c15b7bc76347bb
parente60ba39364e13546ec124a732e19b3a45682d605 (diff)
csharp: updating efl_csharp_application docs.
Summary: ref T8345 Reviewers: lauromoura, felipealmeida, segfaultxavi, woohyun Reviewed By: lauromoura Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8345 Differential Revision: https://phab.enlightenment.org/D10379
-rw-r--r--src/bindings/mono/efl_mono/efl_csharp_application.cs24
1 files changed, 18 insertions, 6 deletions
diff --git a/src/bindings/mono/efl_mono/efl_csharp_application.cs b/src/bindings/mono/efl_mono/efl_csharp_application.cs
index 809b2433bd..b4ce5d2940 100644
--- a/src/bindings/mono/efl_mono/efl_csharp_application.cs
+++ b/src/bindings/mono/efl_mono/efl_csharp_application.cs
@@ -10,14 +10,18 @@ namespace Csharp
10{ 10{
11 11
12/// <summary>The components to be initialized. 12/// <summary>The components to be initialized.
13/// 13/// <para>Since EFL 1.23.</para>
14/// Since EFL 1.23.
15/// </summary> 14/// </summary>
16public enum Components 15public enum Components
17{ 16{
18 ///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.</summary> 17 ///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.
18 /// <para>Since EFL 1.23.</para>
19 /// </summary>
19 Basic, 20 Basic,
20 ///<summary>The same components of <see cref="Efl.Csharp.Components.Basic"/> and the Elementary widget toolkit.</summary> 21 ///<summary>The same components of <see cref="Efl.Csharp.Components.Basic"/>
22 /// and the Elementary widget toolkit.
23 /// <para>Since EFL 1.23.</para>
24 /// </summary>
21 Ui, 25 Ui,
22} 26}
23 27
@@ -25,8 +29,7 @@ public enum Components
25/// This represents the entry point for the EFL framework 29/// This represents the entry point for the EFL framework
26/// You can use this class to implement the 4 abstract methods which will then be called accordingly 30/// You can use this class to implement the 4 abstract methods which will then be called accordingly
27/// All subsystems of efl are booted up correctly when the abstract methods of this class are called. 31/// All subsystems of efl are booted up correctly when the abstract methods of this class are called.
28/// 32/// <para>Since EFL 1.23.</para>
29/// Since EFL 1.23.
30/// </summary> 33/// </summary>
31/// <remarks> 34/// <remarks>
32/// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues 35/// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues
@@ -94,22 +97,27 @@ public abstract class Application
94 97
95 /// <summary> 98 /// <summary>
96 /// Called when the application is started. Arguments from the command line are passed here. 99 /// Called when the application is started. Arguments from the command line are passed here.
100 /// <para>Since EFL 1.23.</para>
97 /// </summary> 101 /// </summary>
102 /// <param name="args">Arguments passed from command line.</param>
98 protected abstract void OnInitialize(string[] args); 103 protected abstract void OnInitialize(string[] args);
99 104
100 /// <summary> 105 /// <summary>
101 /// Arguments are passed here, Additional calls to this function may occure, 106 /// Arguments are passed here, Additional calls to this function may occure,
102 /// but then the initialization flag is set to false. 107 /// but then the initialization flag is set to false.
108 /// <para>Since EFL 1.23.</para>
103 /// </summary> 109 /// </summary>
104 /// <remarks> 110 /// <remarks>
105 /// When Initialize is true then OnInitialize is also called 111 /// When Initialize is true then OnInitialize is also called
106 /// </remarks> 112 /// </remarks>
113 /// <param name="args">Argsuments passed from command line</param>
107 protected virtual void OnArguments(Efl.LoopArguments args) 114 protected virtual void OnArguments(Efl.LoopArguments args)
108 { 115 {
109 } 116 }
110 117
111 /// <summary> 118 /// <summary>
112 /// Called when the application is not going to be displayed, or is not used by a user for some time. 119 /// Called when the application is not going to be displayed, or is not used by a user for some time.
120 /// <para>Since EFL 1.23.</para>
113 /// </summary> 121 /// </summary>
114 protected virtual void OnPause() 122 protected virtual void OnPause()
115 { 123 {
@@ -117,6 +125,7 @@ public abstract class Application
117 125
118 /// <summary> 126 /// <summary>
119 /// Called before an application is used again after a call to OnPause(). 127 /// Called before an application is used again after a call to OnPause().
128 /// <para>Since EFL 1.23.</para>
120 /// </summary> 129 /// </summary>
121 protected virtual void OnResume() 130 protected virtual void OnResume()
122 { 131 {
@@ -124,6 +133,7 @@ public abstract class Application
124 133
125 /// <summary> 134 /// <summary>
126 /// Called before starting the shutdown of the application. 135 /// Called before starting the shutdown of the application.
136 /// <para>Since EFL 1.23.</para>
127 /// </summary> 137 /// </summary>
128 protected virtual void OnTerminate() 138 protected virtual void OnTerminate()
129 { 139 {
@@ -132,7 +142,9 @@ public abstract class Application
132 /// <summary> 142 /// <summary>
133 /// This function initializices everything in EFL and runs your application. 143 /// This function initializices everything in EFL and runs your application.
134 /// This call will result in a call to OnInitialize(), which you application should override. 144 /// This call will result in a call to OnInitialize(), which you application should override.
145 /// <para>Since EFL 1.23.</para>
135 /// </summary> 146 /// </summary>
147 /// <param name="components">The <see cref="Efl.Csharp.Components" /> to run the application.</param>
136 public void Launch(Efl.Csharp.Components components = Components.Ui) 148 public void Launch(Efl.Csharp.Components components = Components.Ui)
137 { 149 {
138 Init(components); 150 Init(components);