lauromoura pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=b19953fe3a9afffb125e85e055ad73bf119f53f0
commit b19953fe3a9afffb125e85e055ad73bf119f53f0 Author: Lauro Moura <[email protected]> Date: Tue Oct 1 00:03:42 2019 -0300 csharp: Add missing since docs to a bunch of classes. Summary: Proper documentation will come in later commits. ref T8293 Reviewers: woohyun, felipealmeida, segfaultxavi, brunobelo Reviewed By: felipealmeida Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8293 Differential Revision: https://phab.enlightenment.org/D10260 --- src/bindings/mono/efl_mono/Bind.cs | 6 ++++++ src/bindings/mono/efl_mono/Factory.cs | 2 ++ src/bindings/mono/efl_mono/GenericModel.cs | 5 ++++- src/bindings/mono/efl_mono/UserModel.cs | 2 ++ src/bindings/mono/efl_mono/efl_all.cs | 2 ++ src/bindings/mono/efl_mono/efl_csharp_application.cs | 5 ++++- src/bindings/mono/eina_mono/eina_error.cs | 1 + src/bindings/mono/eina_mono/eina_hash.cs | 1 + src/bindings/mono/eina_mono/eina_inarray.cs | 1 + src/bindings/mono/eina_mono/eina_inlist.cs | 1 + src/bindings/mono/eina_mono/eina_iterator.cs | 1 + src/bindings/mono/eina_mono/eina_slice.cs | 2 ++ src/bindings/mono/eina_mono/eina_strbuf.cs | 2 +- src/bindings/mono/eina_mono/eina_stringshare.cs | 2 ++ src/bindings/mono/eina_mono/eina_value.cs | 12 ++++++++---- src/bindings/mono/eldbus_mono/eldbus_config.cs | 1 + src/bindings/mono/eldbus_mono/eldbus_connection.cs | 1 + src/bindings/mono/eldbus_mono/eldbus_message.cs | 1 + src/bindings/mono/eldbus_mono/eldbus_object.cs | 2 +- src/bindings/mono/eldbus_mono/eldbus_pending.cs | 1 + src/bindings/mono/eldbus_mono/eldbus_proxy.cs | 1 + 21 files changed, 44 insertions(+), 8 deletions(-) diff --git a/src/bindings/mono/efl_mono/Bind.cs b/src/bindings/mono/efl_mono/Bind.cs index c31186cbb7..27c78593d6 100644 --- a/src/bindings/mono/efl_mono/Bind.cs +++ b/src/bindings/mono/efl_mono/Bind.cs @@ -12,6 +12,8 @@ namespace Efl { /// <summary>Represents a bindable property as used by <see cref="Efl.Ui.ItemFactory<T>" /> instances. /// /// <para>It is internally instantiated and returned by generated extension methods.</para> +/// +/// (Since EFL 1.23) /// </summary> public class BindableProperty<T> { @@ -76,6 +78,8 @@ public class BindableProperty<T> /// <summary>Represents bindable parts as used by <see cref="Efl.Ui.ItemFactory<T>" /> instances. /// /// <para>It is internally instantiated and returned by generated extension methods.</para> +/// +/// (Since EFL 1.23) /// </summary> public class BindablePart<T> { @@ -94,6 +98,8 @@ public class BindablePart<T> } /// <summary>Represents bindable factory parts as used by <see cref="Efl.Ui.ItemFactory<T>" /> instances. +/// +/// (Since EFL 1.23) /// </summary> public class BindableFactoryPart<T> { diff --git a/src/bindings/mono/efl_mono/Factory.cs b/src/bindings/mono/efl_mono/Factory.cs index f2da0c299d..f0d62bbb68 100644 --- a/src/bindings/mono/efl_mono/Factory.cs +++ b/src/bindings/mono/efl_mono/Factory.cs @@ -15,6 +15,8 @@ namespace Efl { namespace Ui { /// factory.Style().Bind("Name"); // The factory Style property is bound to the Name property for the given model. /// </code> /// +/// (Since EFL 1.23) +/// /// </summary> public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable { diff --git a/src/bindings/mono/efl_mono/GenericModel.cs b/src/bindings/mono/efl_mono/GenericModel.cs index 25d9c79955..6b162ed58d 100644 --- a/src/bindings/mono/efl_mono/GenericModel.cs +++ b/src/bindings/mono/efl_mono/GenericModel.cs @@ -9,7 +9,10 @@ using Eina; namespace Efl { -/// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel<T>" /></summary> +/// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel<T>" /> +/// +/// (Since EFL 1.23) +/// </summary> public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable { private Efl.IModel model; diff --git a/src/bindings/mono/efl_mono/UserModel.cs b/src/bindings/mono/efl_mono/UserModel.cs index 33d2a36be6..ffe6f9e6d6 100644 --- a/src/bindings/mono/efl_mono/UserModel.cs +++ b/src/bindings/mono/efl_mono/UserModel.cs @@ -64,6 +64,8 @@ internal class ModelHelper /// var model = new Efl.GenericModel<PersonModel>(modelData, parent); /// PersonModel p = await model.GetAtAsync(0); /// </code> +/// +/// (Since EFL 1.23) /// </summary> [Efl.Eo.BindingEntity] public class UserModel<T> : Efl.MonoModelInternal, IDisposable diff --git a/src/bindings/mono/efl_mono/efl_all.cs b/src/bindings/mono/efl_mono/efl_all.cs index 2eedc4d896..52903013fe 100644 --- a/src/bindings/mono/efl_mono/efl_all.cs +++ b/src/bindings/mono/efl_mono/efl_all.cs @@ -39,6 +39,7 @@ static class UnsafeNativeMethods } } +/// <summary>Wrapper around the initialization functions of all modules. (Since EFL 1.23)</summary> public static class All { private static bool InitializedUi = false; @@ -108,6 +109,7 @@ public static class All namespace Ui { +/// <summary>Initialization and shutdown of the UI libraries. (Since EFL 1.23)</summary> public static class Config { public static void Init() diff --git a/src/bindings/mono/efl_mono/efl_csharp_application.cs b/src/bindings/mono/efl_mono/efl_csharp_application.cs index 92714098c2..5010cc9419 100644 --- a/src/bindings/mono/efl_mono/efl_csharp_application.cs +++ b/src/bindings/mono/efl_mono/efl_csharp_application.cs @@ -9,7 +9,7 @@ namespace Efl namespace Csharp { -///<summary>The components to be initialized.</summary> +///<summary>The components to be initialized. (Since Efl 1.23)</summary> public enum Components { ///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.</summary> @@ -26,6 +26,9 @@ public enum Components /// <remarks> /// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues /// </remarks> +/// +/// (Since EFL 1.23) +/// /// <example> /// UserApp is the class that implements the Application abstract /// <code> diff --git a/src/bindings/mono/eina_mono/eina_error.cs b/src/bindings/mono/eina_mono/eina_error.cs index 0247cb64db..f3f4fbae03 100644 --- a/src/bindings/mono/eina_mono/eina_error.cs +++ b/src/bindings/mono/eina_mono/eina_error.cs @@ -6,6 +6,7 @@ using System.Runtime.InteropServices; namespace Eina { +/// <summary>Error codes from native Eina methods. (Since EFL 1.23)</summary> public struct Error : IComparable<Error> { int code; diff --git a/src/bindings/mono/eina_mono/eina_hash.cs b/src/bindings/mono/eina_mono/eina_hash.cs index dc5c0fd294..aca590fea2 100644 --- a/src/bindings/mono/eina_mono/eina_hash.cs +++ b/src/bindings/mono/eina_mono/eina_hash.cs @@ -130,6 +130,7 @@ public static class HashNativeFunctions eina_hash_iterator_ptr_key_wrapper_new_custom_export_mono(IntPtr hash); } +/// <summary>Wrapper around native dictionary mapping keys to values. (Since EFL 1.23)</summary> public class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey, TValue>>, IDisposable { public IntPtr Handle {get; set;} = IntPtr.Zero; diff --git a/src/bindings/mono/eina_mono/eina_inarray.cs b/src/bindings/mono/eina_mono/eina_inarray.cs index 70f99cb8ca..4ca3babe5a 100644 --- a/src/bindings/mono/eina_mono/eina_inarray.cs +++ b/src/bindings/mono/eina_mono/eina_inarray.cs @@ -67,6 +67,7 @@ public static class InarrayNativeFunctions eina_inarray_accessor_new(IntPtr array); } +/// <summary>Wrapper around an inplace array. (Since EFL 1.23)</summary> public class Inarray<T> : IEnumerable<T>, IDisposable { public static uint DefaultStep = 0; diff --git a/src/bindings/mono/eina_mono/eina_inlist.cs b/src/bindings/mono/eina_mono/eina_inlist.cs index 5f94f44f6a..f93c1ab485 100644 --- a/src/bindings/mono/eina_mono/eina_inlist.cs +++ b/src/bindings/mono/eina_mono/eina_inlist.cs @@ -80,6 +80,7 @@ public static class InlistNativeFunctions eina_inlist_iterator_wrapper_new_custom_export_mono(IntPtr in_list); } +/// <summary>Wrapper around an inplace list. (Since EFL 1.23)</summary> public class Inlist<T> : IEnumerable<T>, IDisposable { public IntPtr Handle {get;set;} = IntPtr.Zero; diff --git a/src/bindings/mono/eina_mono/eina_iterator.cs b/src/bindings/mono/eina_mono/eina_iterator.cs index 0ca4293c8f..47d1627638 100644 --- a/src/bindings/mono/eina_mono/eina_iterator.cs +++ b/src/bindings/mono/eina_mono/eina_iterator.cs @@ -29,6 +29,7 @@ public static class IteratorNativeFunctions eina_carray_iterator_new(IntPtr array); } +/// <summary>Wrapper around a native Eina iterator. (Since EFL 1.23)</summary> public class Iterator<T> : IEnumerable<T>, IDisposable { public IntPtr Handle {get;set;} = IntPtr.Zero; diff --git a/src/bindings/mono/eina_mono/eina_slice.cs b/src/bindings/mono/eina_mono/eina_slice.cs index cb6249c019..1e31f8134d 100644 --- a/src/bindings/mono/eina_mono/eina_slice.cs +++ b/src/bindings/mono/eina_mono/eina_slice.cs @@ -14,6 +14,7 @@ public interface ISliceBase int Length {get;set;} }; +/// <summary>Pointer to a slice of native memory. (Since EFL 1.23)</summary> [StructLayout(LayoutKind.Sequential)] public struct Slice : ISliceBase { @@ -40,6 +41,7 @@ public struct Slice : ISliceBase } } +/// <summary>Pointer to a slice of native memory. (Since EFL 1.23)</summary> [StructLayout(LayoutKind.Sequential)] public struct RwSlice : ISliceBase { diff --git a/src/bindings/mono/eina_mono/eina_strbuf.cs b/src/bindings/mono/eina_mono/eina_strbuf.cs index 6fd35a4638..e6a8ced124 100644 --- a/src/bindings/mono/eina_mono/eina_strbuf.cs +++ b/src/bindings/mono/eina_mono/eina_strbuf.cs @@ -50,7 +50,7 @@ static internal class StrbufNativeMethods } // namespace EinaNative -///<summary>Native string buffer, similar to the C# StringBuilder class.</summary> +///<summary>Native string buffer, similar to the C# StringBuilder class. (Since EFL 1.23)</summary> public class Strbuf : IDisposable { ///<summary>Pointer to the underlying native handle.</summary> diff --git a/src/bindings/mono/eina_mono/eina_stringshare.cs b/src/bindings/mono/eina_mono/eina_stringshare.cs index 5b97e731e4..a8da4f5deb 100644 --- a/src/bindings/mono/eina_mono/eina_stringshare.cs +++ b/src/bindings/mono/eina_mono/eina_stringshare.cs @@ -24,6 +24,8 @@ public static partial class NativeMethods /// <summary> /// Placeholder type to interact with the native type Eina_Stringshare, mainly for eina containers. +/// +/// (Since Efl 1.23) /// </summary> /// <remarks> /// Using System.String and merely converting this type to it (by cast or implicitly) diff --git a/src/bindings/mono/eina_mono/eina_value.cs b/src/bindings/mono/eina_mono/eina_value.cs index 54c437d352..561f696fa4 100644 --- a/src/bindings/mono/eina_mono/eina_value.cs +++ b/src/bindings/mono/eina_mono/eina_value.cs @@ -536,7 +536,7 @@ static internal class UnsafeNativeMethods } } -/// <summary>Struct for passing Values by value to Unmanaged functions.</summary> +/// <summary>Struct for passing Values by value to Unmanaged functions. (Since EFL 1.23)</summary> [StructLayout(LayoutKind.Sequential)] public struct ValueNative { @@ -549,7 +549,7 @@ public struct ValueNative } } -/// <summary>Exception for failures when setting an container item.</summary> +/// <summary>Exception for failures when setting an container item. (Since EFL 1.23)</summary> [Serializable] public class SetItemFailedException : Exception { @@ -574,7 +574,7 @@ public class SetItemFailedException : Exception } } -/// <summary>Exception for methods that must have been called on a container.</summary> +/// <summary>Exception for methods that must have been called on a container. (Since EFL 1.23)</summary> [Serializable] public class InvalidValueTypeException: Exception { @@ -600,7 +600,7 @@ public class InvalidValueTypeException: Exception } -/// <summary>Managed-side Enum to represent Eina_Value_Type constants</summary> +/// <summary>Managed-side Enum to represent Eina_Value_Type constants. (Since EFL 1.23)</summary> public enum ValueType { /// <summary>Signed 8 bit integer. Same as 'sbyte'</summary> @@ -728,6 +728,8 @@ static class ValueTypeMethods /// use this boxing class as an intermediate at the Marshalling API level (like in /// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType /// normally.</para> +/// +/// (Since EFL 1.23) /// </summary> [EditorBrowsable(EditorBrowsableState.Never)] public class ValueTypeBox @@ -932,6 +934,8 @@ static class ValueTypeBridge /// <para>It comes with predefined types for numbers, strings, arrays, lists, hashes, /// blobs and structs. It is able to convert between data types, including /// to and from strings.</para> +/// +/// (Since EFL 1.23) /// </summary> public class Value : IDisposable, IComparable<Value>, IEquatable<Value> { diff --git a/src/bindings/mono/eldbus_mono/eldbus_config.cs b/src/bindings/mono/eldbus_mono/eldbus_config.cs index 08d2386f9b..b2decdf5eb 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_config.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_config.cs @@ -6,6 +6,7 @@ using System.Runtime.InteropServices; namespace eldbus { +/// <summary>Initializes Eldbus. (Since EFL 1.23)</summary> public static class Config { [DllImport(efl.Libs.Eldbus)] private static extern int eldbus_init(); diff --git a/src/bindings/mono/eldbus_mono/eldbus_connection.cs b/src/bindings/mono/eldbus_mono/eldbus_connection.cs index f88f0ac598..8bdc7a161b 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_connection.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_connection.cs @@ -88,6 +88,7 @@ public static class EldbusConnectionNativeFunctions // eldbus_name_owner_changed_callback_del(IntPtr conn, string bus, Eldbus_Name_Owner_Changed_Cb cb, IntPtr cb_data); } +/// <summary>Represents a DBus connection. (Since EFL 1.23)</summary> public class Connection : IDisposable { public enum Type diff --git a/src/bindings/mono/eldbus_mono/eldbus_message.cs b/src/bindings/mono/eldbus_mono/eldbus_message.cs index 559c2f10b9..bb0a8d81c9 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_message.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_message.cs @@ -189,6 +189,7 @@ public static class EldbusMessageNativeFunctions } +/// <summary>Represents a DBus message. (Since EFL 1.23)</summary> public class Message : IDisposable { public IntPtr Handle {get;set;} = IntPtr.Zero; diff --git a/src/bindings/mono/eldbus_mono/eldbus_object.cs b/src/bindings/mono/eldbus_mono/eldbus_object.cs index 682fda6565..b703b48fbf 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_object.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_object.cs @@ -82,7 +82,7 @@ public static class EldbusObjectNativeFunctions // eldbus_object_manager_interfaces_removed(IntPtr obj, Eldbus_Signal_Cb cb, IntPtr cb_data); } - +/// <summary>Represents a DBus object. (Since EFL 1.23)</summary> public class Object : System.IDisposable { diff --git a/src/bindings/mono/eldbus_mono/eldbus_pending.cs b/src/bindings/mono/eldbus_mono/eldbus_pending.cs index fbd8f35be9..65b1f3be35 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_pending.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_pending.cs @@ -41,6 +41,7 @@ public static class EldbusPendingNativeFunctions eldbus_pending_free_cb_del(IntPtr pending, IntPtr cb, IntPtr data); } +/// <summary>Represents a DBus pending. (Since EFL 1.23)</summary> public class Pending { public IntPtr Handle {get;set;} = IntPtr.Zero; diff --git a/src/bindings/mono/eldbus_mono/eldbus_proxy.cs b/src/bindings/mono/eldbus_mono/eldbus_proxy.cs index f5eec40d43..5a2baf211a 100644 --- a/src/bindings/mono/eldbus_mono/eldbus_proxy.cs +++ b/src/bindings/mono/eldbus_mono/eldbus_proxy.cs @@ -65,6 +65,7 @@ public static class EldbusProxyNativeFunctions eldbus_proxy_event_callback_del(IntPtr proxy, int type, IntPtr cb, IntPtr cb_data); } +/// <summary>Represents a DBus proxy object. (Since EFL 1.23)</summary> public class Proxy : IDisposable { public IntPtr Handle {get;set;} = IntPtr.Zero; --
