csharp: Add missing since docs to a bunch of classes.
authorLauro Moura <lauromoura@expertisesolutions.com.br>
Tue, 1 Oct 2019 03:03:42 +0000 (00:03 -0300)
committerJongmin Lee <jm105.lee@samsung.com>
Tue, 1 Oct 2019 21:16:02 +0000 (06:16 +0900)
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

21 files changed:
src/bindings/mono/efl_mono/Bind.cs
src/bindings/mono/efl_mono/Factory.cs
src/bindings/mono/efl_mono/GenericModel.cs
src/bindings/mono/efl_mono/UserModel.cs
src/bindings/mono/efl_mono/efl_all.cs
src/bindings/mono/efl_mono/efl_csharp_application.cs
src/bindings/mono/eina_mono/eina_error.cs
src/bindings/mono/eina_mono/eina_hash.cs
src/bindings/mono/eina_mono/eina_inarray.cs
src/bindings/mono/eina_mono/eina_inlist.cs
src/bindings/mono/eina_mono/eina_iterator.cs
src/bindings/mono/eina_mono/eina_slice.cs
src/bindings/mono/eina_mono/eina_strbuf.cs
src/bindings/mono/eina_mono/eina_stringshare.cs
src/bindings/mono/eina_mono/eina_value.cs
src/bindings/mono/eldbus_mono/eldbus_config.cs
src/bindings/mono/eldbus_mono/eldbus_connection.cs
src/bindings/mono/eldbus_mono/eldbus_message.cs
src/bindings/mono/eldbus_mono/eldbus_object.cs
src/bindings/mono/eldbus_mono/eldbus_pending.cs
src/bindings/mono/eldbus_mono/eldbus_proxy.cs

index c31186c..27c7859 100644 (file)
@@ -12,6 +12,8 @@ namespace Efl {
 /// <summary>Represents a bindable property as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> 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&lt;T&gt;" /> 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&lt;T&gt;" /> instances.
+///
+/// (Since EFL 1.23)
 /// </summary>
 public class BindableFactoryPart<T>
 {
index f2da0c2..f0d62bb 100644 (file)
@@ -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
 {
index 25d9c79..6b162ed 100644 (file)
@@ -9,7 +9,10 @@ using Eina;
 
 namespace Efl {
 
-/// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel&lt;T&gt;" /></summary>
+/// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel&lt;T&gt;" />
+///
+/// (Since EFL 1.23)
+/// </summary>
 public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable
 {
    private Efl.IModel model;
index 33d2a36..ffe6f9e 100644 (file)
@@ -64,6 +64,8 @@ internal class ModelHelper
 /// var model = new Efl.GenericModel&lt;PersonModel&gt;(modelData, parent);
 /// PersonModel p = await model.GetAtAsync(0);
 /// </code>
+///
+/// (Since EFL 1.23)
 /// </summary>
 [Efl.Eo.BindingEntity]
 public class UserModel<T> : Efl.MonoModelInternal, IDisposable
index d7a0954..21d6d16 100644 (file)
@@ -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()
index 8ddfd0a..77ba975 100644 (file)
@@ -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>
index 0247cb6..f3f4fba 100644 (file)
@@ -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;
index dc5c0fd..aca590f 100644 (file)
@@ -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;
index 70f99cb..4ca3bab 100644 (file)
@@ -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;
index 5f94f44..f93c1ab 100644 (file)
@@ -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;
index 0ca4293..47d1627 100644 (file)
@@ -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;
index cb6249c..1e31f81 100644 (file)
@@ -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
 {
index 6fd35a4..e6a8ced 100644 (file)
@@ -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>
index 5b97e73..a8da4f5 100644 (file)
@@ -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)
index 54c437d..561f696 100644 (file)
@@ -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>
 {
index 08d2386..b2decdf 100644 (file)
@@ -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();
index f88f0ac..8bdc7a1 100644 (file)
@@ -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
index 559c2f1..bb0a8d8 100644 (file)
@@ -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;
index 682fda6..b703b48 100644 (file)
@@ -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
 {
 
index fbd8f35..65b1f3b 100644 (file)
@@ -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;
index f5eec40..5a2baf2 100644 (file)
@@ -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;