summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-30 10:26:17 -0300
committerLauro Moura <lauromoura@expertisesolutions.com.br>2019-09-30 10:42:36 -0300
commit62139f2292c9eb0136559fbc0f51300285f39e30 (patch)
tree912a06a2d1fdbf5894e11e929bc1adb55bbc5fee
parenta969f84d03efd207f55a167e378c8d242e0be8f8 (diff)
downloadefl-62139f2292c9eb0136559fbc0f51300285f39e30.tar.gz
mono-docs: Add some missing docs for workaround.cs
Test Plan: Only docs changed. Reviewers: lauromoura Reviewed By: lauromoura Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10249
-rw-r--r--src/bindings/mono/eo_mono/workaround.cs21
1 files changed, 17 insertions, 4 deletions
diff --git a/src/bindings/mono/eo_mono/workaround.cs b/src/bindings/mono/eo_mono/workaround.cs
index a8079e4090..ff254f005d 100644
--- a/src/bindings/mono/eo_mono/workaround.cs
+++ b/src/bindings/mono/eo_mono/workaround.cs
@@ -47,29 +47,42 @@ public struct Efl_Object_Ops
namespace Efl
{
+///<summary>This struct holds the description of a specific event (Since EFL 1.22).</summary>
[StructLayout(LayoutKind.Sequential)]
public struct EventDescription
{
+ ///<summary>Name of the event.</summary>
public IntPtr Name;
+ ///<summary><c>true</c> if the event cannot be frozen.</summary>
[MarshalAs(UnmanagedType.U1)] public bool Unfreezable;
+ ///<summary>Internal use: <c>true</c> if this is a legacy event.</summary>
[MarshalAs(UnmanagedType.U1)] public bool Legacy_is;
+ ///<summary><c>true</c> if when the even is triggered again from a callback it
+ ///will start from where it was.</summary>
[MarshalAs(UnmanagedType.U1)] public bool Restart;
private static Dictionary<string, IntPtr> descriptions = new Dictionary<string, IntPtr>();
- public EventDescription(string module, string name)
+ ///<summary>Constructor for EventDescription</summary>
+ ///<param name="moduleName">The name of the module containing the event.</param>
+ ///<param name="name">The name of the event.</param>
+ public EventDescription(string moduleName, string name)
{
- this.Name = GetNative(module, name);
+ this.Name = GetNative(moduleName, name);
this.Unfreezable = false;
this.Legacy_is = false;
this.Restart = false;
}
- public static IntPtr GetNative(string module, string name)
+ ///<summary>Get the native structure.</summary>
+ ///<param name="moduleName">The name of the module containing the event.</param>
+ ///<param name="name">The name of the event.</param>
+ ///<returns>Pointer to the native structure.</returns>
+ public static IntPtr GetNative(string moduleName, string name)
{
if (!descriptions.ContainsKey(name))
{
- IntPtr data = Efl.Eo.FunctionInterop.LoadFunctionPointer(module, name);
+ IntPtr data = Efl.Eo.FunctionInterop.LoadFunctionPointer(moduleName, name);
if (data == IntPtr.Zero)
{