From: Lauro Moura Date: Tue, 1 Oct 2019 03:03:42 +0000 (-0300) Subject: csharp: Add missing since docs to a bunch of classes. X-Git-Tag: accepted/tizen/unified/20191004.003716~8 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=330597f704538522fa13f1b3ef4465713c8d41b9;p=platform%2Fupstream%2Fefl.git 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 --- diff --git a/src/bindings/mono/efl_mono/Bind.cs b/src/bindings/mono/efl_mono/Bind.cs index c31186c..27c7859 100644 --- a/src/bindings/mono/efl_mono/Bind.cs +++ b/src/bindings/mono/efl_mono/Bind.cs @@ -12,6 +12,8 @@ namespace Efl { /// Represents a bindable property as used by instances. /// /// It is internally instantiated and returned by generated extension methods. +/// +/// (Since EFL 1.23) /// public class BindableProperty { @@ -76,6 +78,8 @@ public class BindableProperty /// Represents bindable parts as used by instances. /// /// It is internally instantiated and returned by generated extension methods. +/// +/// (Since EFL 1.23) /// public class BindablePart { @@ -94,6 +98,8 @@ public class BindablePart } /// Represents bindable factory parts as used by instances. +/// +/// (Since EFL 1.23) /// public class BindableFactoryPart { diff --git a/src/bindings/mono/efl_mono/Factory.cs b/src/bindings/mono/efl_mono/Factory.cs index f2da0c2..f0d62bb 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. /// /// +/// (Since EFL 1.23) +/// /// public class ItemFactory : Efl.Ui.LayoutFactory, IDisposable { diff --git a/src/bindings/mono/efl_mono/GenericModel.cs b/src/bindings/mono/efl_mono/GenericModel.cs index 25d9c79..6b162ed 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 { -/// Generic implementation for MVVM models based on +/// Generic implementation for MVVM models based on +/// +/// (Since EFL 1.23) +/// public class GenericModel : 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 33d2a36..ffe6f9e 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); /// +/// +/// (Since EFL 1.23) /// [Efl.Eo.BindingEntity] public class UserModel : Efl.MonoModelInternal, IDisposable diff --git a/src/bindings/mono/efl_mono/efl_all.cs b/src/bindings/mono/efl_mono/efl_all.cs index d7a0954..21d6d16 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 } } +/// Wrapper around the initialization functions of all modules. (Since EFL 1.23) public static class All { private static bool InitializedUi = false; @@ -108,6 +109,7 @@ public static class All namespace Ui { +/// Initialization and shutdown of the UI libraries. (Since EFL 1.23) 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 8ddfd0a..77ba975 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 { -///The components to be initialized. +///The components to be initialized. (Since Efl 1.23) public enum Components { ///Basic components: Eina, Eo, Ecore, Evas and DBus. @@ -26,6 +26,9 @@ public enum Components /// /// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues /// +/// +/// (Since EFL 1.23) +/// /// /// UserApp is the class that implements the Application abstract /// diff --git a/src/bindings/mono/eina_mono/eina_error.cs b/src/bindings/mono/eina_mono/eina_error.cs index 0247cb6..f3f4fba 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 { +/// Error codes from native Eina methods. (Since EFL 1.23) public struct Error : IComparable { int code; diff --git a/src/bindings/mono/eina_mono/eina_hash.cs b/src/bindings/mono/eina_mono/eina_hash.cs index dc5c0fd..aca590f 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); } +/// Wrapper around native dictionary mapping keys to values. (Since EFL 1.23) public class Hash : IEnumerable>, 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 70f99cb..4ca3bab 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); } +/// Wrapper around an inplace array. (Since EFL 1.23) public class Inarray : IEnumerable, 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 5f94f44..f93c1ab 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); } +/// Wrapper around an inplace list. (Since EFL 1.23) public class Inlist : IEnumerable, 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 0ca4293..47d1627 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); } +/// Wrapper around a native Eina iterator. (Since EFL 1.23) public class Iterator : IEnumerable, 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 cb6249c..1e31f81 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;} }; +/// Pointer to a slice of native memory. (Since EFL 1.23) [StructLayout(LayoutKind.Sequential)] public struct Slice : ISliceBase { @@ -40,6 +41,7 @@ public struct Slice : ISliceBase } } +/// Pointer to a slice of native memory. (Since EFL 1.23) [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 6fd35a4..e6a8ced 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 -///Native string buffer, similar to the C# StringBuilder class. +///Native string buffer, similar to the C# StringBuilder class. (Since EFL 1.23) public class Strbuf : IDisposable { ///Pointer to the underlying native handle. diff --git a/src/bindings/mono/eina_mono/eina_stringshare.cs b/src/bindings/mono/eina_mono/eina_stringshare.cs index 5b97e73..a8da4f5 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 /// /// Placeholder type to interact with the native type Eina_Stringshare, mainly for eina containers. +/// +/// (Since Efl 1.23) /// /// /// 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 54c437d..561f696 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 } } -/// Struct for passing Values by value to Unmanaged functions. +/// Struct for passing Values by value to Unmanaged functions. (Since EFL 1.23) [StructLayout(LayoutKind.Sequential)] public struct ValueNative { @@ -549,7 +549,7 @@ public struct ValueNative } } -/// Exception for failures when setting an container item. +/// Exception for failures when setting an container item. (Since EFL 1.23) [Serializable] public class SetItemFailedException : Exception { @@ -574,7 +574,7 @@ public class SetItemFailedException : Exception } } -/// Exception for methods that must have been called on a container. +/// Exception for methods that must have been called on a container. (Since EFL 1.23) [Serializable] public class InvalidValueTypeException: Exception { @@ -600,7 +600,7 @@ public class InvalidValueTypeException: Exception } -/// Managed-side Enum to represent Eina_Value_Type constants +/// Managed-side Enum to represent Eina_Value_Type constants. (Since EFL 1.23) public enum ValueType { /// Signed 8 bit integer. Same as 'sbyte' @@ -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. +/// +/// (Since EFL 1.23) /// [EditorBrowsable(EditorBrowsableState.Never)] public class ValueTypeBox @@ -932,6 +934,8 @@ static class ValueTypeBridge /// 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. +/// +/// (Since EFL 1.23) /// public class Value : IDisposable, IComparable, IEquatable { diff --git a/src/bindings/mono/eldbus_mono/eldbus_config.cs b/src/bindings/mono/eldbus_mono/eldbus_config.cs index 08d2386..b2decdf 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 { +/// Initializes Eldbus. (Since EFL 1.23) 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 f88f0ac..8bdc7a1 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); } +/// Represents a DBus connection. (Since EFL 1.23) 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 559c2f1..bb0a8d8 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 } +/// Represents a DBus message. (Since EFL 1.23) 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 682fda6..b703b48 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); } - +/// Represents a DBus object. (Since EFL 1.23) 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 fbd8f35..65b1f3b 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); } +/// Represents a DBus pending. (Since EFL 1.23) 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 f5eec40..5a2baf2 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); } +/// Represents a DBus proxy object. (Since EFL 1.23) public class Proxy : IDisposable { public IntPtr Handle {get;set;} = IntPtr.Zero;