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
This commit is contained in:
Lauro Moura 2019-10-01 00:03:42 -03:00
parent 5ae7d92a1b
commit b19953fe3a
21 changed files with 44 additions and 8 deletions

View File

@ -12,6 +12,8 @@ namespace Efl {
/// <summary>Represents a bindable property as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances. /// <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> /// <para>It is internally instantiated and returned by generated extension methods.</para>
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
public class BindableProperty<T> 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. /// <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> /// <para>It is internally instantiated and returned by generated extension methods.</para>
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
public class BindablePart<T> 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. /// <summary>Represents bindable factory parts as used by <see cref="Efl.Ui.ItemFactory&lt;T&gt;" /> instances.
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
public class BindableFactoryPart<T> public class BindableFactoryPart<T>
{ {

View 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. /// factory.Style().Bind("Name"); // The factory Style property is bound to the Name property for the given model.
/// </code> /// </code>
/// ///
/// (Since EFL 1.23)
///
/// </summary> /// </summary>
public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable
{ {

View File

@ -9,7 +9,10 @@ using Eina;
namespace Efl { 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 public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable
{ {
private Efl.IModel model; private Efl.IModel model;

View File

@ -64,6 +64,8 @@ internal class ModelHelper
/// var model = new Efl.GenericModel&lt;PersonModel&gt;(modelData, parent); /// var model = new Efl.GenericModel&lt;PersonModel&gt;(modelData, parent);
/// PersonModel p = await model.GetAtAsync(0); /// PersonModel p = await model.GetAtAsync(0);
/// </code> /// </code>
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
[Efl.Eo.BindingEntity] [Efl.Eo.BindingEntity]
public class UserModel<T> : Efl.MonoModelInternal, IDisposable public class UserModel<T> : Efl.MonoModelInternal, IDisposable

View 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 public static class All
{ {
private static bool InitializedUi = false; private static bool InitializedUi = false;
@ -108,6 +109,7 @@ public static class All
namespace Ui namespace Ui
{ {
/// <summary>Initialization and shutdown of the UI libraries. (Since EFL 1.23)</summary>
public static class Config public static class Config
{ {
public static void Init() public static void Init()

View File

@ -9,7 +9,7 @@ namespace Efl
namespace Csharp namespace Csharp
{ {
///<summary>The components to be initialized.</summary> ///<summary>The components to be initialized. (Since Efl 1.23)</summary>
public enum Components public enum Components
{ {
///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.</summary> ///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.</summary>
@ -26,6 +26,9 @@ public enum Components
/// <remarks> /// <remarks>
/// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues /// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues
/// </remarks> /// </remarks>
///
/// (Since EFL 1.23)
///
/// <example> /// <example>
/// UserApp is the class that implements the Application abstract /// UserApp is the class that implements the Application abstract
/// <code> /// <code>

View File

@ -6,6 +6,7 @@ using System.Runtime.InteropServices;
namespace Eina namespace Eina
{ {
/// <summary>Error codes from native Eina methods. (Since EFL 1.23)</summary>
public struct Error : IComparable<Error> public struct Error : IComparable<Error>
{ {
int code; int code;

View File

@ -130,6 +130,7 @@ public static class HashNativeFunctions
eina_hash_iterator_ptr_key_wrapper_new_custom_export_mono(IntPtr hash); 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 class Hash<TKey, TValue> : IEnumerable<KeyValuePair<TKey,TValue>>, IDisposable
{ {
public IntPtr Handle {get; set;} = IntPtr.Zero; public IntPtr Handle {get; set;} = IntPtr.Zero;

View File

@ -67,6 +67,7 @@ public static class InarrayNativeFunctions
eina_inarray_accessor_new(IntPtr array); 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 class Inarray<T> : IEnumerable<T>, IDisposable
{ {
public static uint DefaultStep = 0; public static uint DefaultStep = 0;

View File

@ -80,6 +80,7 @@ public static class InlistNativeFunctions
eina_inlist_iterator_wrapper_new_custom_export_mono(IntPtr in_list); 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 class Inlist<T> : IEnumerable<T>, IDisposable
{ {
public IntPtr Handle {get;set;} = IntPtr.Zero; public IntPtr Handle {get;set;} = IntPtr.Zero;

View File

@ -29,6 +29,7 @@ public static class IteratorNativeFunctions
eina_carray_iterator_new(IntPtr array); 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 class Iterator<T> : IEnumerable<T>, IDisposable
{ {
public IntPtr Handle {get;set;} = IntPtr.Zero; public IntPtr Handle {get;set;} = IntPtr.Zero;

View File

@ -14,6 +14,7 @@ public interface ISliceBase
int Length {get;set;} int Length {get;set;}
}; };
/// <summary>Pointer to a slice of native memory. (Since EFL 1.23)</summary>
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
public struct Slice : ISliceBase 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)] [StructLayout(LayoutKind.Sequential)]
public struct RwSlice : ISliceBase public struct RwSlice : ISliceBase
{ {

View File

@ -50,7 +50,7 @@ static internal class StrbufNativeMethods
} // namespace EinaNative } // 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 public class Strbuf : IDisposable
{ {
///<summary>Pointer to the underlying native handle.</summary> ///<summary>Pointer to the underlying native handle.</summary>

View File

@ -24,6 +24,8 @@ public static partial class NativeMethods
/// <summary> /// <summary>
/// Placeholder type to interact with the native type Eina_Stringshare, mainly for eina containers. /// Placeholder type to interact with the native type Eina_Stringshare, mainly for eina containers.
///
/// (Since Efl 1.23)
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Using System.String and merely converting this type to it (by cast or implicitly) /// Using System.String and merely converting this type to it (by cast or implicitly)

View 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)] [StructLayout(LayoutKind.Sequential)]
public struct ValueNative 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] [Serializable]
public class SetItemFailedException : Exception 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] [Serializable]
public class InvalidValueTypeException: Exception 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 public enum ValueType
{ {
/// <summary>Signed 8 bit integer. Same as 'sbyte'</summary> /// <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 /// 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 /// marshall_type_impl.hh in the generator). User-facing API still uses Eina.ValueType
/// normally.</para> /// normally.</para>
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)] [EditorBrowsable(EditorBrowsableState.Never)]
public class ValueTypeBox public class ValueTypeBox
@ -932,6 +934,8 @@ static class ValueTypeBridge
/// <para>It comes with predefined types for numbers, strings, arrays, lists, hashes, /// <para>It comes with predefined types for numbers, strings, arrays, lists, hashes,
/// blobs and structs. It is able to convert between data types, including /// blobs and structs. It is able to convert between data types, including
/// to and from strings.</para> /// to and from strings.</para>
///
/// (Since EFL 1.23)
/// </summary> /// </summary>
public class Value : IDisposable, IComparable<Value>, IEquatable<Value> public class Value : IDisposable, IComparable<Value>, IEquatable<Value>
{ {

View File

@ -6,6 +6,7 @@ using System.Runtime.InteropServices;
namespace eldbus namespace eldbus
{ {
/// <summary>Initializes Eldbus. (Since EFL 1.23)</summary>
public static class Config public static class Config
{ {
[DllImport(efl.Libs.Eldbus)] private static extern int eldbus_init(); [DllImport(efl.Libs.Eldbus)] private static extern int eldbus_init();

View 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); // 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 class Connection : IDisposable
{ {
public enum Type public enum Type

View File

@ -189,6 +189,7 @@ public static class EldbusMessageNativeFunctions
} }
/// <summary>Represents a DBus message. (Since EFL 1.23)</summary>
public class Message : IDisposable public class Message : IDisposable
{ {
public IntPtr Handle {get;set;} = IntPtr.Zero; public IntPtr Handle {get;set;} = IntPtr.Zero;

View File

@ -82,7 +82,7 @@ public static class EldbusObjectNativeFunctions
// eldbus_object_manager_interfaces_removed(IntPtr obj, Eldbus_Signal_Cb cb, IntPtr cb_data); // 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 public class Object : System.IDisposable
{ {

View File

@ -41,6 +41,7 @@ public static class EldbusPendingNativeFunctions
eldbus_pending_free_cb_del(IntPtr pending, IntPtr cb, IntPtr data); 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 class Pending
{ {
public IntPtr Handle {get;set;} = IntPtr.Zero; public IntPtr Handle {get;set;} = IntPtr.Zero;

View File

@ -65,6 +65,7 @@ public static class EldbusProxyNativeFunctions
eldbus_proxy_event_callback_del(IntPtr proxy, int type, IntPtr cb, IntPtr cb_data); 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 class Proxy : IDisposable
{ {
public IntPtr Handle {get;set;} = IntPtr.Zero; public IntPtr Handle {get;set;} = IntPtr.Zero;