csharp: Standardizing doc tag.

Reviewers: felipealmeida, brunobelo, segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D10280
This commit is contained in:
Bruno da Silva Belo 2019-10-04 08:46:29 +02:00 committed by Xavi Artigas
parent 94733b4926
commit 04a49f5875
29 changed files with 139 additions and 46 deletions

View File

@ -560,7 +560,7 @@ struct documentation_generator
{ {
std::string str = doc.full_text; std::string str = doc.full_text;
if (!doc.since.empty()) if (!doc.since.empty())
str += "\\<br/\\>Since EFL " + doc.since; str += "\\<br/\\>Since EFL " + doc.since + ".";
str += tail_text; str += tail_text;
return generate_tag_summary(sink, str, context); return generate_tag_summary(sink, str, context);
} }

View File

@ -13,7 +13,7 @@ namespace Efl {
/// ///
/// <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) /// Since EFL 1.23.
/// </summary> /// </summary>
public class BindableProperty<T> public class BindableProperty<T>
{ {
@ -79,7 +79,7 @@ public class BindableProperty<T>
/// ///
/// <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) /// Since EFL 1.23.
/// </summary> /// </summary>
public class BindablePart<T> public class BindablePart<T>
{ {
@ -99,7 +99,7 @@ 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) /// Since EFL 1.23.
/// </summary> /// </summary>
public class BindableFactoryPart<T> public class BindableFactoryPart<T>
{ {

View File

@ -15,7 +15,7 @@ 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) /// Since EFL 1.23.
/// ///
/// </summary> /// </summary>
public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable

View File

@ -11,7 +11,7 @@ namespace Efl {
/// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel&lt;T&gt;" /> /// <summary>Generic <see cref="Efl.IModel" /> implementation for MVVM models based on <see cref="Efl.UserModel&lt;T&gt;" />
/// ///
/// (Since EFL 1.23) /// Since EFL 1.23.
/// </summary> /// </summary>
public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable
{ {

View File

@ -65,7 +65,7 @@ internal class ModelHelper
/// PersonModel p = await model.GetAtAsync(0); /// PersonModel p = await model.GetAtAsync(0);
/// </code> /// </code>
/// ///
/// (Since EFL 1.23) /// 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,7 +39,10 @@ static class UnsafeNativeMethods
} }
} }
/// <summary>Wrapper around the initialization functions of all modules. (Since EFL 1.23)</summary> /// <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;
@ -109,7 +112,10 @@ public static class All
namespace Ui namespace Ui
{ {
/// <summary>Initialization and shutdown of the UI libraries. (Since EFL 1.23)</summary> /// <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,10 @@ namespace Efl
namespace Csharp namespace Csharp
{ {
///<summary>The components to be initialized. (Since Efl 1.23)</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>
@ -22,13 +25,13 @@ public enum Components
/// This represents the entry point for the EFL framework /// This represents the entry point for the EFL framework
/// You can use this class to implement the 4 abstract methods which will then be called accordingly /// You can use this class to implement the 4 abstract methods which will then be called accordingly
/// All subsystems of efl are booted up correctly when the abstract methods of this class are called. /// All subsystems of efl are booted up correctly when the abstract methods of this class are called.
///
/// Since EFL 1.23.
/// </summary> /// </summary>
/// <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

@ -19,7 +19,10 @@ internal class AccessorNativeFunctions
} }
/// <summary>Accessors provide an uniform way of accessing Eina containers, /// <summary>Accessors provide an uniform way of accessing Eina containers,
/// similar to C++ STL's and C# IEnumerable (SINCE EFL 1.23).</summary> /// similar to C++ STL's and C# IEnumerable.
///
/// Since EFL 1.23.
/// </summary>
public class Accessor<T> : IEnumerable<T>, IDisposable public class Accessor<T> : IEnumerable<T>, IDisposable
{ {
/// <summary>Pointer to the native accessor.</summary> /// <summary>Pointer to the native accessor.</summary>
@ -133,7 +136,10 @@ public class Accessor<T> : IEnumerable<T>, IDisposable
} }
} }
///<summary>Accessor for Inlists (SINCE EFL 1.23).</summary> /// <summary>Accessor for Inlists.
///
/// Since EFL 1.23.
/// </summary>
public class AccessorInList<T> : Accessor<T> public class AccessorInList<T> : Accessor<T>
{ {
/// <summary>Create a new accessor wrapping the given pointer.</summary> /// <summary>Create a new accessor wrapping the given pointer.</summary>
@ -153,7 +159,10 @@ public class AccessorInList<T> : Accessor<T>
} }
} }
///<summary>Accessor for Inarrays (SINCE EFL 1.23).</summary> /// <summary>Accessor for Inarrays.
///
/// Since EFL 1.23.
/// </summary>
public class AccessorInArray<T> : Accessor<T> public class AccessorInArray<T> : Accessor<T>
{ {
/// <summary>Create a new accessor wrapping the given pointer.</summary> /// <summary>Create a new accessor wrapping the given pointer.</summary>

View File

@ -45,7 +45,10 @@ public static class ArrayNativeFunctions
eina_array_foreach_custom_export_mono(IntPtr array, IntPtr cb, IntPtr fdata); eina_array_foreach_custom_export_mono(IntPtr array, IntPtr cb, IntPtr fdata);
} }
/// <summary>A container of contiguous allocated elements (SINCE EFL 1.23).</summary> /// <summary>A container of contiguous allocated elements.
///
/// Since EFL 1.23.
/// </summary>
public class Array<T> : IEnumerable<T>, IDisposable public class Array<T> : IEnumerable<T>, IDisposable
{ {
public static uint DefaultStep = 32; public static uint DefaultStep = 32;

View File

@ -7,7 +7,9 @@ namespace Eina
{ {
/// <summary> /// <summary>
/// A Generic buffer designed to be a mutable string (SINCE EFL 1.23). /// A Generic buffer designed to be a mutable string.
///
/// Since EFL 1.23.
/// </summary> /// </summary>
public class Binbuf : IDisposable public class Binbuf : IDisposable
{ {

View File

@ -41,7 +41,10 @@ internal static class NativeCustomExportFunctions
efl_mono_native_efl_unref_addr_get(); efl_mono_native_efl_unref_addr_get();
} }
/// <summary>Wrapper around native memory DllImport'd functions (SINCE EFL 1.23).</summary> /// <summary>Wrapper around native memory DllImport'd functions.
///
/// Since EFL 1.23.
/// </summary>
public static class MemoryNative public static class MemoryNative
{ {
public static void Free(IntPtr ptr) public static void Free(IntPtr ptr)
@ -127,7 +130,9 @@ public static class MemoryNative
} }
/// <summary> /// <summary>
/// Conversor of raw pointer to a type and type to raw pointer (SINCE EFL 1.23). /// Conversor of raw pointer to a type and type to raw pointer
///
/// Since EFL 1.23.
/// </summary> /// </summary>
public static class PrimitiveConversion public static class PrimitiveConversion
{ {
@ -152,7 +157,9 @@ public static class PrimitiveConversion
} }
/// <summary> /// <summary>
/// Conversor of string to native string and native string to string.. (SINCE EFL 1.23). /// Conversor of string to native string and native string to string.
///
/// Since EFL 1.23.
/// </summary> /// </summary>
public static class StringConversion public static class StringConversion
{ {

View File

@ -7,7 +7,9 @@ namespace Eina
{ {
/// <summary> /// <summary>
/// Manage the initialization and cleanup for eina (SINCE EFL 1.23). /// Manage the initialization and cleanup for eina.
///
/// Since EFL 1.23.
/// </summary> /// </summary>
public class Config public class Config
{ {
@ -30,8 +32,9 @@ public class Config
} }
/// <summary> /// <summary>
/// Wrapper class for pointers that need some cleanup afterwards /// Wrapper class for pointers that need some cleanup afterwards like strings
/// like strings (SINCE EFL 1.23). ///
/// Since EFL 1.23.
/// </summary> /// </summary>
public class DisposableIntPtr : IDisposable public class DisposableIntPtr : IDisposable
{ {

View File

@ -6,7 +6,10 @@ using System.Runtime.InteropServices;
namespace Eina namespace Eina
{ {
/// <summary>Error codes from native Eina methods. (Since EFL 1.23)</summary> /// <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,7 +130,10 @@ 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> /// <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,7 +67,10 @@ 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> /// <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,7 +80,10 @@ 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> /// <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,7 +29,10 @@ 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> /// <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

@ -106,7 +106,10 @@ public static class ListNativeFunctions
eina_list_last_data_get_custom_export_mono(IntPtr list); eina_list_last_data_get_custom_export_mono(IntPtr list);
} }
/// <summary>Native wrapper around a linked list of items. (Since EFL 1.23)</summary> /// <summary>Native wrapper around a linked list of items.
///
/// Since EFL 1.23.
/// </summary>
public class List<T> : IEnumerable<T>, IDisposable public class List<T> : IEnumerable<T>, IDisposable
{ {

View File

@ -9,7 +9,10 @@ namespace Eina
{ {
// Manual wrappers around eina functions // Manual wrappers around eina functions
/// <summary>EFL Logging facilities. (Since EFL 1.23)</summary> /// <summary>EFL Logging facilities.
///
/// Since EFL 1.23.
/// </summary>
public class Log public class Log
{ {
[DllImport(efl.Libs.Eina)] private static extern void eina_log_print( [DllImport(efl.Libs.Eina)] private static extern void eina_log_print(

View File

@ -71,7 +71,7 @@ static internal class PromiseNativeMethods
/// ///
/// With a Promise you can attach futures to it, which will be used to notify of the value being available. /// With a Promise you can attach futures to it, which will be used to notify of the value being available.
/// ///
/// (Since Efl 1.23) /// Since Efl 1.23.
/// </summary> /// </summary>
public class Promise : IDisposable public class Promise : IDisposable
{ {

View File

@ -14,7 +14,10 @@ public interface ISliceBase
int Length {get;set;} int Length {get;set;}
}; };
/// <summary>Pointer to a slice of native memory. (Since EFL 1.23)</summary> /// <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
{ {
@ -41,7 +44,10 @@ public struct Slice : ISliceBase
} }
} }
/// <summary>Pointer to a slice of native memory. (Since EFL 1.23)</summary> /// <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,10 @@ static internal class StrbufNativeMethods
} // namespace EinaNative } // namespace EinaNative
///<summary>Native string buffer, similar to the C# StringBuilder class. (Since EFL 1.23)</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

@ -536,7 +536,10 @@ static internal class UnsafeNativeMethods
} }
} }
/// <summary>Struct for passing Values by value to Unmanaged functions. (Since EFL 1.23)</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 +552,10 @@ public struct ValueNative
} }
} }
/// <summary>Exception for failures when setting an container item. (Since EFL 1.23)</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 +580,10 @@ public class SetItemFailedException : Exception
} }
} }
/// <summary>Exception for methods that must have been called on a container. (Since EFL 1.23)</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 +609,10 @@ public class InvalidValueTypeException: Exception
} }
/// <summary>Managed-side Enum to represent Eina_Value_Type constants. (Since EFL 1.23)</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>
@ -729,7 +741,7 @@ static class ValueTypeMethods
/// 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) /// Since EFL 1.23.
/// </summary> /// </summary>
[EditorBrowsable(EditorBrowsableState.Never)] [EditorBrowsable(EditorBrowsableState.Never)]
public class ValueTypeBox public class ValueTypeBox
@ -935,7 +947,7 @@ static class ValueTypeBridge
/// 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) /// 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,7 +6,10 @@ using System.Runtime.InteropServices;
namespace eldbus namespace eldbus
{ {
/// <summary>Initializes Eldbus. (Since EFL 1.23)</summary> /// <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,7 +88,10 @@ 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> /// <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,7 +189,10 @@ public static class EldbusMessageNativeFunctions
} }
/// <summary>Represents a DBus message. (Since EFL 1.23)</summary> /// <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,10 @@ 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> /// <summary>Represents a DBus object.
///
/// Since EFL 1.23.
/// </summary>
public class Object : System.IDisposable public class Object : System.IDisposable
{ {

View File

@ -41,7 +41,10 @@ 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> /// <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,7 +65,10 @@ 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> /// <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;