diff --git a/src/bindings/mono/eina_mono/eina_list.cs b/src/bindings/mono/eina_mono/eina_list.cs index cf787455bd..bb269db0ea 100644 --- a/src/bindings/mono/eina_mono/eina_list.cs +++ b/src/bindings/mono/eina_mono/eina_list.cs @@ -107,24 +107,33 @@ public static class ListNativeFunctions } /// Native wrapper around a linked list of items. -/// -/// Since EFL 1.23. +/// Since EFL 1.23. /// public class List : IEnumerable, IDisposable { [EditorBrowsable(EditorBrowsableState.Never)] public IntPtr Handle {get;set;} = IntPtr.Zero; - /// Whether this managed list owns the native one. + /// Whether this managed list owns the native one. + /// Since EFL 1.23. + /// public bool Own {get;set;} - /// Whether the native list wrapped owns the content it points to. + /// Whether the native list wrapped owns the content it points to. + /// Since EFL 1.23. + /// public bool OwnContent {get;set;} - /// Delegate for comparing two elements of this list. + /// Delegate for comparing two elements of this list. + /// Since EFL 1.23. + /// + /// First element. + /// Second element. /// -1, 0 or 1 for respectively smaller, equal or larger. public delegate int Compare(T a, T b); - /// The number of elements on this list. + /// The number of elements on this list. + /// Since EFL 1.23. + /// public int Length { get { return Count(); } @@ -164,7 +173,9 @@ public class List : IEnumerable, IDisposable } - /// Creates a new empty list. + /// Creates a new empty list. + /// Since EFL 1.23. + /// public List() { InitNew(); @@ -188,13 +199,17 @@ public class List : IEnumerable, IDisposable OwnContent = ownContent; } - /// Finalizes this list. + /// Finalizes this list. + /// Since EFL 1.23. + /// ~List() { Dispose(false); } - /// Disposes of this list. + /// Disposes of this list. + /// Since EFL 1.23. + /// /// Whether this was called from the finalizer (false) or from the /// method. protected virtual void Dispose(bool disposing) @@ -227,20 +242,26 @@ public class List : IEnumerable, IDisposable } } - /// Disposes of this list. + /// Disposes of this list. + /// Since EFL 1.23. + /// public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } - /// Disposes of this list. + /// Disposes of this list. + /// Since EFL 1.23. + /// public void Free() { Dispose(); } - /// Relinquishes of the native list. + /// Relinquishes of the native list. + /// Since EFL 1.23. + /// /// The previously wrapped native list handle. public IntPtr Release() { @@ -249,27 +270,40 @@ public class List : IEnumerable, IDisposable return h; } - /// Sets whether this wrapper should own the native list or not. + /// Sets whether this wrapper should own the native list or not. + /// Since EFL 1.23. + /// + /// If the hash own for all ownerships. public void SetOwnership(bool ownAll) { Own = ownAll; OwnContent = ownAll; } - /// Sets whether this wrapper should own the native list and its content or not. + /// Sets whether this wrapper should own the native list and + /// its content or not. + /// Since EFL 1.23. + /// + /// If own the object. + /// If own the content's object. public void SetOwnership(bool own, bool ownContent) { Own = own; OwnContent = ownContent; } - /// Returns the number of elements in this list. + /// Returns the number of elements in this list. + /// Since EFL 1.23. + /// + /// The number of elements. public int Count() { return (int)eina_list_count_custom_export_mono(Handle); } - /// Appends val to the list. + /// Appends val to the list. + /// Since EFL 1.23. + /// /// The item to be appended. public void Append(T val) { @@ -277,7 +311,9 @@ public class List : IEnumerable, IDisposable Handle = eina_list_append(Handle, ele); } - /// Prepends val to the list. + /// Prepends val to the list. + /// Since EFL 1.23. + /// /// The item to be prepended. public void Prepend(T val) { @@ -285,7 +321,10 @@ public class List : IEnumerable, IDisposable Handle = eina_list_prepend(Handle, ele); } - /// Inserts val in the list in a sorted manner. It presumes the list is already sorted. + /// Inserts val in the list in a sorted manner. + /// It presumes the list is already sorted. + /// Since EFL 1.23. + /// /// The item to be inserted. public void SortedInsert(T val) { @@ -293,8 +332,11 @@ public class List : IEnumerable, IDisposable Handle = eina_list_sorted_insert(Handle, EinaCompareCb(), ele); } - /// Inserts val in the list in a sorted manner with the given compareCb for element comparison. - /// It presumes the list is already sorted. + /// Inserts val in the list in a sorted manner with the + /// given compareCb for element comparison. + /// It presumes the list is already sorted. + /// Since EFL 1.23. + /// /// The function to compare two elements of the list. /// The item to be inserted. public void SortedInsert(Compare compareCb, T val) @@ -303,21 +345,27 @@ public class List : IEnumerable, IDisposable Handle = eina_list_sorted_insert(Handle, Marshal.GetFunctionPointerForDelegate(GetNativeCompareCb(compareCb)), ele); } - /// Sorts limit elements in this list inplace. + /// Sorts limit elements in this list inplace. + /// Since EFL 1.23. + /// /// The max number of elements to be sorted. public void Sort(int limit = 0) { Handle = eina_list_sort(Handle, (uint)limit, EinaCompareCb()); } - /// Sorts all elements in this list inplace. + /// Sorts all elements in this list inplace. + /// Since EFL 1.23. + /// /// The function to compare two elements of the list. public void Sort(Compare compareCb) { Handle = eina_list_sort(Handle, 0, Marshal.GetFunctionPointerForDelegate(GetNativeCompareCb(compareCb))); } - /// Sorts limit elements in this list inplace. + /// Sorts limit elements in this list inplace. + /// Since EFL 1.23. + /// /// The max number of elements to be sorted. /// The function to compare two elements of the list. public void Sort(int limit, Compare compareCb) @@ -333,8 +381,11 @@ public class List : IEnumerable, IDisposable } /// Returns the nth element of this list. Due to marshalling details, the returned element - /// may be a different C# object from the one you used to append. + /// may be a different C# object from the one you used to append. + /// Since EFL 1.23. + /// /// The 0-based index to be retrieved. + /// The value in the specified element. public T Nth(int n) { // TODO: check bounds ??? @@ -342,7 +393,9 @@ public class List : IEnumerable, IDisposable return NativeToManaged(ele); } - /// Sets the data at the idx position. + /// Sets the data at the idx position. + /// Since EFL 1.23. + /// /// The 0-based index to be set. /// The value to be inserted. public void DataSet(int idx, T val) @@ -362,7 +415,9 @@ public class List : IEnumerable, IDisposable InternalDataSet(pos, ele); } - /// Accessor for the data at the idx position. + /// Accessor for the data at the idx position. + /// Since EFL 1.23. + /// /// The 0-based index to be get/set. public T this[int idx] { @@ -376,7 +431,9 @@ public class List : IEnumerable, IDisposable } } - /// Returns the data at the last list element. + /// Returns the data at the last list element. + /// Since EFL 1.23. + /// /// The value contained in the last list position. public T LastDataGet() { @@ -384,7 +441,9 @@ public class List : IEnumerable, IDisposable return NativeToManaged(ele); } - /// Reverses this list in place. + /// Reverses this list in place. + /// Since EFL 1.23. + /// /// A reference to this object. public List Reverse() { @@ -392,13 +451,17 @@ public class List : IEnumerable, IDisposable return this; } - /// Randomly shuffles this list in place. + /// Randomly shuffles this list in place. + /// Since EFL 1.23. + /// public void Shuffle() { Handle = eina_list_shuffle(Handle, IntPtr.Zero); } - /// Gets a C# array of the elements in this list. + /// Gets a C# array of the elements in this list. + /// Since EFL 1.23. + /// /// A managed array of the elements. public T[] ToArray() { @@ -412,7 +475,9 @@ public class List : IEnumerable, IDisposable return managed; } - /// Appends the given array of elements to this list. + /// Appends the given array of elements to this list. + /// Since EFL 1.23. + /// /// The values to be appended. public void AppendArray(T[] values) { @@ -423,21 +488,27 @@ public class List : IEnumerable, IDisposable } - /// Gets an iterator that iterates this list in normal order. + /// Gets an iterator that iterates this list in normal order. + /// Since EFL 1.23. + /// /// The iterator. public Eina.Iterator GetIterator() { return new Eina.Iterator(eina_list_iterator_new(Handle), true); } - /// Gets an iterator that iterates this list in reverse order. + /// Gets an iterator that iterates this list in reverse order. + /// Since EFL 1.23. + /// /// The iterator. public Eina.Iterator GetReversedIterator() { return new Eina.Iterator(eina_list_iterator_reversed_new(Handle), true); } - /// Gets an enumerator into this list. + /// Gets an enumerator into this list. + /// Since EFL 1.23. + /// /// The enumerator. public IEnumerator GetEnumerator() { @@ -447,14 +518,18 @@ public class List : IEnumerable, IDisposable } } - /// Gets an enumerator into this list. + /// Gets an enumerator into this list. + /// Since EFL 1.23. + /// /// The enumerator. System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { return this.GetEnumerator(); } - /// Gets an Accessor for this List. + /// Gets an Accessor for this List. + /// Since EFL 1.23. + /// /// The accessor. public Eina.Accessor GetAccessor() {