csharp: Standardizing doc tag.
authorBruno da Silva Belo <brunodasilvabelo@gmail.com>
Fri, 4 Oct 2019 06:46:29 +0000 (08:46 +0200)
committerJongmin Lee <jm105.lee@samsung.com>
Sun, 6 Oct 2019 21:16:07 +0000 (06:16 +0900)
Reviewers: felipealmeida, brunobelo, segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D10280

29 files changed:
src/bin/eolian_mono/eolian/mono/documentation.hh
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_accessor.cs
src/bindings/mono/eina_mono/eina_array.cs
src/bindings/mono/eina_mono/eina_binbuf.cs
src/bindings/mono/eina_mono/eina_common.cs
src/bindings/mono/eina_mono/eina_config.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_list.cs
src/bindings/mono/eina_mono/eina_log.cs
src/bindings/mono/eina_mono/eina_promises.cs
src/bindings/mono/eina_mono/eina_slice.cs
src/bindings/mono/eina_mono/eina_strbuf.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 0035754..0bdfbda 100644 (file)
@@ -560,7 +560,7 @@ struct documentation_generator
    {
       std::string str = doc.full_text;
       if (!doc.since.empty())
-        str += "\\<br/\\>Since EFL " + doc.since;
+        str += "\\<br/\\>Since EFL " + doc.since + ".";
       str += tail_text;
       return generate_tag_summary(sink, str, context);
    }
index 27c7859..c4aec5b 100644 (file)
@@ -13,7 +13,7 @@ namespace Efl {
 ///
 /// <para>It is internally instantiated and returned by generated extension methods.</para>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 public class BindableProperty<T>
 {
@@ -79,7 +79,7 @@ public class BindableProperty<T>
 ///
 /// <para>It is internally instantiated and returned by generated extension methods.</para>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 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.
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 public class BindableFactoryPart<T>
 {
index f0d62bb..2c9f139 100644 (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.
 /// </code>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 ///
 /// </summary>
 public class ItemFactory<T> : Efl.Ui.LayoutFactory, IDisposable
index 6b162ed..79cca5f 100644 (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;" />
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 public class GenericModel<T> : Efl.Object, Efl.IModel, IDisposable
 {
index ffe6f9e..08e6f6e 100644 (file)
@@ -65,7 +65,7 @@ internal class ModelHelper
 /// PersonModel p = await model.GetAtAsync(0);
 /// </code>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 [Efl.Eo.BindingEntity]
 public class UserModel<T> : Efl.MonoModelInternal, IDisposable
index 21d6d16..ff4b1e7 100644 (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
 {
     private static bool InitializedUi = false;
@@ -109,7 +112,10 @@ public static class All
 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 void Init()
index 77ba975..74f37b3 100644 (file)
@@ -9,7 +9,10 @@ namespace Efl
 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
 {
     ///<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
 /// 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.
+///
+/// Since EFL 1.23.
 /// </summary>
 /// <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 6442c55..5880503 100644 (file)
@@ -19,7 +19,10 @@ internal class AccessorNativeFunctions
 }
 
 /// <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
 {
     /// <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>
 {
     /// <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>
 {
     /// <summary>Create a new accessor wrapping the given pointer.</summary>
index 90cc4b4..655fbab 100644 (file)
@@ -45,7 +45,10 @@ public static class ArrayNativeFunctions
         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 static uint DefaultStep = 32;
index 3dcda65..66b89e2 100644 (file)
@@ -7,7 +7,9 @@ namespace Eina
 {
 
 /// <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>
 public class Binbuf : IDisposable
 {
index d552f75..77ed8b7 100644 (file)
@@ -41,7 +41,10 @@ internal static class NativeCustomExportFunctions
         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 void Free(IntPtr ptr)
@@ -127,7 +130,9 @@ public static class MemoryNative
 }
 
 /// <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>
 public static class PrimitiveConversion
 {
@@ -152,7 +157,9 @@ public static class PrimitiveConversion
 }
 
 /// <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>
 public static class StringConversion
 {
index 3b35b21..1b57da0 100644 (file)
@@ -7,7 +7,9 @@ namespace Eina
 {
 
 /// <summary>
-///   Manage the initialization and cleanup for eina (SINCE EFL 1.23).
+/// Manage the initialization and cleanup for eina.
+///
+/// Since EFL 1.23.
 /// </summary>
 public class Config
 {
@@ -30,8 +32,9 @@ public class Config
 }
 
 /// <summary>
-/// Wrapper class for pointers that need some cleanup afterwards
-/// like strings (SINCE EFL 1.23).
+/// Wrapper class for pointers that need some cleanup afterwards like strings
+///
+/// Since EFL 1.23.
 /// </summary>
 public class DisposableIntPtr : IDisposable
 {
index f3f4fba..a1b4f1e 100644 (file)
@@ -6,7 +6,10 @@ using System.Runtime.InteropServices;
 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>
 {
     int code;
index aca590f..f4678a1 100644 (file)
@@ -130,7 +130,10 @@ 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>
+/// <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 4ca3bab..a9c8d5f 100644 (file)
@@ -67,7 +67,10 @@ public static class InarrayNativeFunctions
         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 static uint DefaultStep = 0;
index f93c1ab..ed98730 100644 (file)
@@ -80,7 +80,10 @@ 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>
+/// <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 47d1627..defbd96 100644 (file)
@@ -29,7 +29,10 @@ public static class IteratorNativeFunctions
         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 IntPtr Handle {get;set;} = IntPtr.Zero;
index 7521ed6..cf78745 100644 (file)
@@ -106,7 +106,10 @@ public static class ListNativeFunctions
         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
 {
 
index 1e0de41..5782ef6 100644 (file)
@@ -9,7 +9,10 @@ namespace Eina
 {
 // 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
 {
     [DllImport(efl.Libs.Eina)] private static extern void eina_log_print(
index 2d0f99d..897d200 100644 (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.
 ///
-/// (Since Efl 1.23)
+/// Since Efl 1.23.
 /// </summary>
 public class Promise : IDisposable
 {
index 1e31f81..a0c8fd9 100644 (file)
@@ -14,7 +14,10 @@ public interface ISliceBase
     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)]
 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)]
 public struct RwSlice : ISliceBase
 {
index e6a8ced..97664d9 100644 (file)
@@ -50,7 +50,10 @@ static internal class StrbufNativeMethods
 
 } // 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
 {
     ///<summary>Pointer to the underlying native handle.</summary>
index 561f696..d3791bd 100644 (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)]
 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]
 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]
 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
 {
     /// <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
 /// normally.</para>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 [EditorBrowsable(EditorBrowsableState.Never)]
 public class ValueTypeBox
@@ -935,7 +947,7 @@ static class ValueTypeBridge
 /// blobs and structs. It is able to convert between data types, including
 /// to and from strings.</para>
 ///
-/// (Since EFL 1.23)
+/// Since EFL 1.23.
 /// </summary>
 public class Value : IDisposable, IComparable<Value>, IEquatable<Value>
 {
index b2decdf..b0a0c1f 100644 (file)
@@ -6,7 +6,10 @@ using System.Runtime.InteropServices;
 namespace eldbus
 {
 
-/// <summary>Initializes Eldbus. (Since EFL 1.23)</summary>
+/// <summary>Initializes Eldbus.
+///
+/// Since EFL 1.23.
+/// </summary>
 public static class Config
 {
     [DllImport(efl.Libs.Eldbus)] private static extern int eldbus_init();
index 8bdc7a1..18ec10f 100644 (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);
 }
 
-/// <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 enum Type
index bb0a8d8..2bd7431 100644 (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 IntPtr Handle {get;set;} = IntPtr.Zero;
index b703b48..d86ad6c 100644 (file)
@@ -82,7 +82,10 @@ 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>
+/// <summary>Represents a DBus object.
+///
+/// Since EFL 1.23.
+/// </summary>
 public class Object : System.IDisposable
 {
 
index 65b1f3b..3570ca1 100644 (file)
@@ -41,7 +41,10 @@ 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>
+/// <summary>Represents a DBus pending.
+///
+/// Since EFL 1.23.
+/// </summary>
 public class Pending
 {
     public IntPtr Handle {get;set;} = IntPtr.Zero;
index 5a2baf2..2d692cd 100644 (file)
@@ -65,7 +65,10 @@ 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>
+/// <summary>Represents a DBus proxy object.
+///
+/// Since EFL 1.23.
+/// </summary>
 public class Proxy : IDisposable
 {
     public IntPtr Handle {get;set;} = IntPtr.Zero;