diff options
author | Jaehyun Cho <jae_hyun.cho@samsung.com> | 2019-12-17 20:04:01 +0900 |
---|---|---|
committer | Jaehyun Cho <jae_hyun.cho@samsung.com> | 2019-12-17 20:18:54 +0900 |
commit | bfc095104cf286485672ea78049ca2677e6e5fea (patch) | |
tree | 7d7ba98376c4e09f39e68aa8d51994e465f657d5 | |
parent | 0f52bbb00e49d93c564b4b95ddf1c1726076a317 (diff) |
csharp: apply same form of "Since EFL" to all manual bindings .cs files
The following form of "Since EFL" is applied to descriptions of all
manual bindings .cs files.
/// <para>Since EFL 1.XX.</para>
-rw-r--r-- | src/bindings/mono/efl_mono/efl_csharp_application.cs | 2 | ||||
-rw-r--r-- | src/bindings/mono/eina_mono/eina_environment.cs | 6 | ||||
-rw-r--r-- | src/bindings/mono/eina_mono/eina_hash.cs | 2 | ||||
-rw-r--r-- | src/bindings/mono/eina_mono/eina_slice.cs | 6 | ||||
-rw-r--r-- | src/bindings/mono/eina_mono/eina_value.cs | 2 | ||||
-rw-r--r-- | src/bindings/mono/eldbus_mono/eldbus_object.cs | 4 | ||||
-rw-r--r-- | src/bindings/mono/eo_mono/iwrapper.cs | 4 | ||||
-rw-r--r-- | src/bindings/mono/eo_mono/workaround.cs | 25 |
8 files changed, 29 insertions, 22 deletions
diff --git a/src/bindings/mono/efl_mono/efl_csharp_application.cs b/src/bindings/mono/efl_mono/efl_csharp_application.cs index 63d9aacae8..17a777ec42 100644 --- a/src/bindings/mono/efl_mono/efl_csharp_application.cs +++ b/src/bindings/mono/efl_mono/efl_csharp_application.cs | |||
@@ -43,7 +43,7 @@ public enum Components : Int32 | |||
43 | /// <summary> | 43 | /// <summary> |
44 | /// Elementary Widget toolkit: Elm. | 44 | /// Elementary Widget toolkit: Elm. |
45 | /// <para>it's depend of <see cref="Efl.Csharp.Components.Basic" />.</para> | 45 | /// <para>it's depend of <see cref="Efl.Csharp.Components.Basic" />.</para> |
46 | /// <para>Since EFL 1.24</para> | 46 | /// <para>Since EFL 1.24.</para> |
47 | /// </summary> | 47 | /// </summary> |
48 | Ui = Basic | 0x2, | 48 | Ui = Basic | 0x2, |
49 | 49 | ||
diff --git a/src/bindings/mono/eina_mono/eina_environment.cs b/src/bindings/mono/eina_mono/eina_environment.cs index 7cef31cbf1..e7f847b4e2 100644 --- a/src/bindings/mono/eina_mono/eina_environment.cs +++ b/src/bindings/mono/eina_mono/eina_environment.cs | |||
@@ -16,7 +16,7 @@ internal static class Environment | |||
16 | /// <summary> | 16 | /// <summary> |
17 | /// Returns the value of the environment variable named <c>name</c>. | 17 | /// Returns the value of the environment variable named <c>name</c>. |
18 | /// | 18 | /// |
19 | /// <para>Since EFL 1.24</para> | 19 | /// <para>Since EFL 1.24.</para> |
20 | /// </summary> | 20 | /// </summary> |
21 | /// <param name="name">The name of the variable to be retrieved</param> | 21 | /// <param name="name">The name of the variable to be retrieved</param> |
22 | /// <returns>The value of the variable. <c>null</c> if not set.</returns> | 22 | /// <returns>The value of the variable. <c>null</c> if not set.</returns> |
@@ -28,7 +28,7 @@ internal static class Environment | |||
28 | /// <summary> | 28 | /// <summary> |
29 | /// Sets a native environment variable. | 29 | /// Sets a native environment variable. |
30 | /// | 30 | /// |
31 | /// <para>Since EFL 1.24</para> | 31 | /// <para>Since EFL 1.24.</para> |
32 | /// </summary> | 32 | /// </summary> |
33 | /// <param name="name">The name of the variable</param> | 33 | /// <param name="name">The name of the variable</param> |
34 | /// <param name="value">The value to be set.</param> | 34 | /// <param name="value">The value to be set.</param> |
@@ -50,4 +50,4 @@ internal static partial class NativeCustomExportFunctions | |||
50 | public static extern Eina.Error efl_mono_native_setenv(string name, string value, int overwrite); | 50 | public static extern Eina.Error efl_mono_native_setenv(string name, string value, int overwrite); |
51 | } | 51 | } |
52 | 52 | ||
53 | } \ No newline at end of file | 53 | } |
diff --git a/src/bindings/mono/eina_mono/eina_hash.cs b/src/bindings/mono/eina_mono/eina_hash.cs index c254d58ae5..5b6f4735c1 100644 --- a/src/bindings/mono/eina_mono/eina_hash.cs +++ b/src/bindings/mono/eina_mono/eina_hash.cs | |||
@@ -196,7 +196,7 @@ public static class HashNativeFunctions | |||
196 | 196 | ||
197 | /// <summary>Wrapper around native dictionary mapping keys to values. | 197 | /// <summary>Wrapper around native dictionary mapping keys to values. |
198 | /// | 198 | /// |
199 | /// Since EFL 1.23. | 199 | /// <para>Since EFL 1.23.</para> |
200 | /// </summary> | 200 | /// </summary> |
201 | public class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey, TValue>>, IDisposable | 201 | public class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey, TValue>>, IDisposable |
202 | { | 202 | { |
diff --git a/src/bindings/mono/eina_mono/eina_slice.cs b/src/bindings/mono/eina_mono/eina_slice.cs index c7a1fd984f..e47da1071c 100644 --- a/src/bindings/mono/eina_mono/eina_slice.cs +++ b/src/bindings/mono/eina_mono/eina_slice.cs | |||
@@ -49,7 +49,7 @@ public interface ISliceBase | |||
49 | 49 | ||
50 | /// <summary>Pointer to a slice of native memory. | 50 | /// <summary>Pointer to a slice of native memory. |
51 | /// | 51 | /// |
52 | /// Since EFL 1.23. | 52 | /// <para>Since EFL 1.23.</para> |
53 | /// </summary> | 53 | /// </summary> |
54 | [StructLayout(LayoutKind.Sequential)] | 54 | [StructLayout(LayoutKind.Sequential)] |
55 | public struct Slice : ISliceBase, IEquatable<Slice> | 55 | public struct Slice : ISliceBase, IEquatable<Slice> |
@@ -114,7 +114,7 @@ public struct Slice : ISliceBase, IEquatable<Slice> | |||
114 | => (Length == other.Length) ^ (Mem == other.Mem); | 114 | => (Length == other.Length) ^ (Mem == other.Mem); |
115 | 115 | ||
116 | /// <summary>Returns whether <c>lhs</c> is equal to <c>rhs</c>. | 116 | /// <summary>Returns whether <c>lhs</c> is equal to <c>rhs</c>. |
117 | /// <para>Since EFL 1.24</para> | 117 | /// <para>Since EFL 1.24.</para> |
118 | /// </summary> | 118 | /// </summary> |
119 | /// <param name="lhs">The left hand side of the operator.</param> | 119 | /// <param name="lhs">The left hand side of the operator.</param> |
120 | /// <param name="rhs">The right hand side of the operator.</param> | 120 | /// <param name="rhs">The right hand side of the operator.</param> |
@@ -134,7 +134,7 @@ public struct Slice : ISliceBase, IEquatable<Slice> | |||
134 | 134 | ||
135 | /// <summary>Pointer to a slice of native memory. | 135 | /// <summary>Pointer to a slice of native memory. |
136 | /// | 136 | /// |
137 | /// Since EFL 1.23. | 137 | /// <para>Since EFL 1.23.</para> |
138 | /// </summary> | 138 | /// </summary> |
139 | [StructLayout(LayoutKind.Sequential)] | 139 | [StructLayout(LayoutKind.Sequential)] |
140 | public struct RwSlice : ISliceBase, IEquatable<RwSlice> | 140 | public struct RwSlice : ISliceBase, IEquatable<RwSlice> |
diff --git a/src/bindings/mono/eina_mono/eina_value.cs b/src/bindings/mono/eina_mono/eina_value.cs index 2a2508e08b..5b203812da 100644 --- a/src/bindings/mono/eina_mono/eina_value.cs +++ b/src/bindings/mono/eina_mono/eina_value.cs | |||
@@ -927,7 +927,7 @@ static class ValueTypeMethods | |||
927 | /// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType | 927 | /// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType |
928 | /// normally.</para> | 928 | /// normally.</para> |
929 | /// | 929 | /// |
930 | /// Since EFL 1.23. | 930 | /// <para>Since EFL 1.23.</para> |
931 | /// </summary> | 931 | /// </summary> |
932 | [EditorBrowsable(EditorBrowsableState.Never)] | 932 | [EditorBrowsable(EditorBrowsableState.Never)] |
933 | public class ValueTypeBox | 933 | public class ValueTypeBox |
diff --git a/src/bindings/mono/eldbus_mono/eldbus_object.cs b/src/bindings/mono/eldbus_mono/eldbus_object.cs index 3c77d258c4..ed78fc7a15 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_object.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_object.cs | |||
@@ -292,9 +292,7 @@ public class Object : System.IDisposable | |||
292 | /// <summary> | 292 | /// <summary> |
293 | /// Decrease object reference. | 293 | /// Decrease object reference. |
294 | /// <para>If reference == 0 object will be freed and all its children.</para> | 294 | /// <para>If reference == 0 object will be freed and all its children.</para> |
295 | ///<para> | 295 | /// <para>Since EFL 1.23.</para> |
296 | /// Since EFL 1.23. | ||
297 | ///</para> | ||
298 | /// </summary> | 296 | /// </summary> |
299 | public void Unref() | 297 | public void Unref() |
300 | { | 298 | { |
diff --git a/src/bindings/mono/eo_mono/iwrapper.cs b/src/bindings/mono/eo_mono/iwrapper.cs index c84433c23e..ed61634328 100644 --- a/src/bindings/mono/eo_mono/iwrapper.cs +++ b/src/bindings/mono/eo_mono/iwrapper.cs | |||
@@ -1034,7 +1034,7 @@ internal static class ClassRegister | |||
1034 | /// | 1034 | /// |
1035 | /// <para>For internal usage by generated code.</para> | 1035 | /// <para>For internal usage by generated code.</para> |
1036 | /// | 1036 | /// |
1037 | /// <para>Since EFL 1.24</para> | 1037 | /// <para>Since EFL 1.24.</para> |
1038 | /// </summary> | 1038 | /// </summary> |
1039 | class MarshalEoNoMove : ICustomMarshaler | 1039 | class MarshalEoNoMove : ICustomMarshaler |
1040 | { | 1040 | { |
@@ -1117,7 +1117,7 @@ class MarshalEoNoMove : ICustomMarshaler | |||
1117 | /// | 1117 | /// |
1118 | /// <para>For internal usage by generated code.</para> | 1118 | /// <para>For internal usage by generated code.</para> |
1119 | /// | 1119 | /// |
1120 | /// <para>Since EFL 1.24</para> | 1120 | /// <para>Since EFL 1.24.</para> |
1121 | /// </summary> | 1121 | /// </summary> |
1122 | class MarshalEoMove : ICustomMarshaler | 1122 | class MarshalEoMove : ICustomMarshaler |
1123 | { | 1123 | { |
diff --git a/src/bindings/mono/eo_mono/workaround.cs b/src/bindings/mono/eo_mono/workaround.cs index de8ab97efd..7b0ceab056 100644 --- a/src/bindings/mono/eo_mono/workaround.cs +++ b/src/bindings/mono/eo_mono/workaround.cs | |||
@@ -111,7 +111,10 @@ internal struct EflObjectOps | |||
111 | namespace Efl | 111 | namespace Efl |
112 | { | 112 | { |
113 | 113 | ||
114 | ///<summary>This struct holds the description of a specific event (Since EFL 1.22).</summary> | 114 | /// <summary> |
115 | /// This struct holds the description of a specific event. | ||
116 | /// <para>Since EFL 1.22.</para> | ||
117 | /// </summary> | ||
115 | [StructLayout(LayoutKind.Sequential)] | 118 | [StructLayout(LayoutKind.Sequential)] |
116 | internal struct EventDescription | 119 | internal struct EventDescription |
117 | { | 120 | { |
@@ -164,25 +167,31 @@ internal struct EventDescription | |||
164 | /// <summary> | 167 | /// <summary> |
165 | /// A parameter passed in event callbacks holding extra event parameters. | 168 | /// A parameter passed in event callbacks holding extra event parameters. |
166 | /// This is the full event information passed to callbacks in C. | 169 | /// This is the full event information passed to callbacks in C. |
167 | /// (Since EFL 1.22) | 170 | /// <para>Since EFL 1.22.</para> |
168 | /// </summary> | 171 | /// </summary> |
169 | [StructLayout(LayoutKind.Sequential)] | 172 | [StructLayout(LayoutKind.Sequential)] |
170 | [Efl.Eo.BindingEntity] | 173 | [Efl.Eo.BindingEntity] |
171 | internal struct Event | 174 | internal struct Event |
172 | { | 175 | { |
173 | /// <summary>The object the callback was called on. | 176 | /// <summary> |
174 | /// (Since EFL 1.22)</summary> | 177 | /// The object the callback was called on. |
178 | /// <para>Since EFL 1.22.</para> | ||
179 | /// </summary> | ||
175 | public Efl.Object Object; | 180 | public Efl.Object Object; |
176 | 181 | ||
177 | /// <summary>The event description. | 182 | /// <summary> |
178 | /// (Since EFL 1.22)</summary> | 183 | /// The event description. |
184 | /// <para>Since EFL 1.22.</para> | ||
185 | /// </summary> | ||
179 | public Efl.EventDescription Desc; | 186 | public Efl.EventDescription Desc; |
180 | 187 | ||
181 | /// <summary>Extra event information passed by the event caller. | 188 | /// <summary> |
189 | /// Extra event information passed by the event caller. | ||
182 | /// Must be cast to the event type declared in the EO file. Keep in mind that: | 190 | /// Must be cast to the event type declared in the EO file. Keep in mind that: |
183 | /// 1) Objects are passed as a normal Eo*. Event subscribers can call functions on these objects. | 191 | /// 1) Objects are passed as a normal Eo*. Event subscribers can call functions on these objects. |
184 | /// 2) Structs, built-in types and containers are passed as const pointers, with one level of indirection. | 192 | /// 2) Structs, built-in types and containers are passed as const pointers, with one level of indirection. |
185 | /// (Since EFL 1.22)</summary> | 193 | /// <para>Since EFL 1.22.</para> |
194 | /// </summary> | ||
186 | public System.IntPtr Info; | 195 | public System.IntPtr Info; |
187 | 196 | ||
188 | /// <summary>Constructor for Event.</summary> | 197 | /// <summary>Constructor for Event.</summary> |