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>
This commit is contained in:
Jaehyun Cho 2019-12-17 20:04:01 +09:00
parent 0f52bbb00e
commit bfc095104c
8 changed files with 29 additions and 22 deletions

View File

@ -43,7 +43,7 @@ public enum Components : Int32
/// <summary> /// <summary>
/// Elementary Widget toolkit: Elm. /// Elementary Widget toolkit: Elm.
/// <para>it's depend of <see cref="Efl.Csharp.Components.Basic" />.</para> /// <para>it's depend of <see cref="Efl.Csharp.Components.Basic" />.</para>
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
Ui = Basic | 0x2, Ui = Basic | 0x2,

View File

@ -16,7 +16,7 @@ internal static class Environment
/// <summary> /// <summary>
/// Returns the value of the environment variable named <c>name</c>. /// Returns the value of the environment variable named <c>name</c>.
/// ///
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
/// <param name="name">The name of the variable to be retrieved</param> /// <param name="name">The name of the variable to be retrieved</param>
/// <returns>The value of the variable. <c>null</c> if not set.</returns> /// <returns>The value of the variable. <c>null</c> if not set.</returns>
@ -28,7 +28,7 @@ internal static class Environment
/// <summary> /// <summary>
/// Sets a native environment variable. /// Sets a native environment variable.
/// ///
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
/// <param name="name">The name of the variable</param> /// <param name="name">The name of the variable</param>
/// <param name="value">The value to be set.</param> /// <param name="value">The value to be set.</param>
@ -50,4 +50,4 @@ internal static partial class NativeCustomExportFunctions
public static extern Eina.Error efl_mono_native_setenv(string name, string value, int overwrite); public static extern Eina.Error efl_mono_native_setenv(string name, string value, int overwrite);
} }
} }

View File

@ -196,7 +196,7 @@ public static class HashNativeFunctions
/// <summary>Wrapper around native dictionary mapping keys to values. /// <summary>Wrapper around native dictionary mapping keys to values.
/// ///
/// Since EFL 1.23. /// <para>Since EFL 1.23.</para>
/// </summary> /// </summary>
public class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey,TValue>>, IDisposable public class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey,TValue>>, IDisposable
{ {

View File

@ -49,7 +49,7 @@ public interface ISliceBase
/// <summary>Pointer to a slice of native memory. /// <summary>Pointer to a slice of native memory.
/// ///
/// Since EFL 1.23. /// <para>Since EFL 1.23.</para>
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
public struct Slice : ISliceBase, IEquatable<Slice> public struct Slice : ISliceBase, IEquatable<Slice>
@ -114,7 +114,7 @@ public struct Slice : ISliceBase, IEquatable<Slice>
=> (Length == other.Length) ^ (Mem == other.Mem); => (Length == other.Length) ^ (Mem == other.Mem);
/// <summary>Returns whether <c>lhs</c> is equal to <c>rhs</c>. /// <summary>Returns whether <c>lhs</c> is equal to <c>rhs</c>.
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
/// <param name="lhs">The left hand side of the operator.</param> /// <param name="lhs">The left hand side of the operator.</param>
/// <param name="rhs">The right hand side of the operator.</param> /// <param name="rhs">The right hand side of the operator.</param>
@ -134,7 +134,7 @@ public struct Slice : ISliceBase, IEquatable<Slice>
/// <summary>Pointer to a slice of native memory. /// <summary>Pointer to a slice of native memory.
/// ///
/// Since EFL 1.23. /// <para>Since EFL 1.23.</para>
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
public struct RwSlice : ISliceBase, IEquatable<RwSlice> public struct RwSlice : ISliceBase, IEquatable<RwSlice>

View File

@ -927,7 +927,7 @@ static class ValueTypeMethods
/// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType /// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType
/// normally.</para> /// normally.</para>
/// ///
/// Since EFL 1.23. /// <para>Since EFL 1.23.</para>
/// </summary> /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)] [EditorBrowsable(EditorBrowsableState.Never)]
public class ValueTypeBox public class ValueTypeBox

View File

@ -292,9 +292,7 @@ public class Object : System.IDisposable
/// <summary> /// <summary>
/// Decrease object reference. /// Decrease object reference.
/// <para>If reference == 0 object will be freed and all its children.</para> /// <para>If reference == 0 object will be freed and all its children.</para>
///<para> /// <para>Since EFL 1.23.</para>
/// Since EFL 1.23.
///</para>
/// </summary> /// </summary>
public void Unref() public void Unref()
{ {

View File

@ -1034,7 +1034,7 @@ internal static class ClassRegister
/// ///
/// <para>For internal usage by generated code.</para> /// <para>For internal usage by generated code.</para>
/// ///
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
class MarshalEoNoMove : ICustomMarshaler class MarshalEoNoMove : ICustomMarshaler
{ {
@ -1117,7 +1117,7 @@ class MarshalEoNoMove : ICustomMarshaler
/// ///
/// <para>For internal usage by generated code.</para> /// <para>For internal usage by generated code.</para>
/// ///
/// <para>Since EFL 1.24</para> /// <para>Since EFL 1.24.</para>
/// </summary> /// </summary>
class MarshalEoMove : ICustomMarshaler class MarshalEoMove : ICustomMarshaler
{ {

View File

@ -111,7 +111,10 @@ internal struct EflObjectOps
namespace Efl namespace Efl
{ {
///<summary>This struct holds the description of a specific event (Since EFL 1.22).</summary> /// <summary>
/// This struct holds the description of a specific event.
/// <para>Since EFL 1.22.</para>
/// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
internal struct EventDescription internal struct EventDescription
{ {
@ -164,25 +167,31 @@ internal struct EventDescription
/// <summary> /// <summary>
/// A parameter passed in event callbacks holding extra event parameters. /// A parameter passed in event callbacks holding extra event parameters.
/// This is the full event information passed to callbacks in C. /// This is the full event information passed to callbacks in C.
/// (Since EFL 1.22) /// <para>Since EFL 1.22.</para>
/// </summary> /// </summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
[Efl.Eo.BindingEntity] [Efl.Eo.BindingEntity]
internal struct Event internal struct Event
{ {
/// <summary>The object the callback was called on. /// <summary>
/// (Since EFL 1.22)</summary> /// The object the callback was called on.
/// <para>Since EFL 1.22.</para>
/// </summary>
public Efl.Object Object; public Efl.Object Object;
/// <summary>The event description. /// <summary>
/// (Since EFL 1.22)</summary> /// The event description.
/// <para>Since EFL 1.22.</para>
/// </summary>
public Efl.EventDescription Desc; public Efl.EventDescription Desc;
/// <summary>Extra event information passed by the event caller. /// <summary>
/// Extra event information passed by the event caller.
/// Must be cast to the event type declared in the EO file. Keep in mind that: /// Must be cast to the event type declared in the EO file. Keep in mind that:
/// 1) Objects are passed as a normal Eo*. Event subscribers can call functions on these objects. /// 1) Objects are passed as a normal Eo*. Event subscribers can call functions on these objects.
/// 2) Structs, built-in types and containers are passed as const pointers, with one level of indirection. /// 2) Structs, built-in types and containers are passed as const pointers, with one level of indirection.
/// (Since EFL 1.22)</summary> /// <para>Since EFL 1.22.</para>
/// </summary>
public System.IntPtr Info; public System.IntPtr Info;
/// <summary>Constructor for Event.</summary> /// <summary>Constructor for Event.</summary>