summaryrefslogtreecommitdiff
path: root/src/bindings/mono/eo_mono
diff options
context:
space:
mode:
authorVitor Sousa <vitorsousa@expertisesolutions.com.br>2019-07-08 17:18:47 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-08 17:20:08 +0200
commitec501a6623e8132caea14ad7e382d6e7c2f348c0 (patch)
tree48753cad1442ca9e9649842791980cadd6739731 /src/bindings/mono/eo_mono
parentec7bc0eddd7abc77d28605b0a6f0aea2e246a0ee (diff)
csharp: fix some build warnings related with incorrect and missing documentation
Summary: Some parameter names, tag names and cref identifiers in the documentation were incorrect and causing warnings during compilation. There were also warnings related with missing documentation in publicly visible elements in the manual binding. This commit fixes these incorrections and adds documentation to the manual binding in order to solve these compilation warnings. Warnings related with missing documentation in `.eo` files are still present. Test Plan: Just compile with mono binding. Reviewers: lauromoura, felipealmeida, segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D9243
Diffstat (limited to 'src/bindings/mono/eo_mono')
-rw-r--r--src/bindings/mono/eo_mono/EoWrapper.cs30
-rw-r--r--src/bindings/mono/eo_mono/iwrapper.cs4
2 files changed, 30 insertions, 4 deletions
diff --git a/src/bindings/mono/eo_mono/EoWrapper.cs b/src/bindings/mono/eo_mono/EoWrapper.cs
index 5b14b48..03edea0 100644
--- a/src/bindings/mono/eo_mono/EoWrapper.cs
+++ b/src/bindings/mono/eo_mono/EoWrapper.cs
@@ -10,8 +10,15 @@ namespace Efl
10namespace Eo 10namespace Eo
11{ 11{
12 12
13/// <summary>
14/// Abstract class that delivers base level binding to Efl Objects.
15///
16/// Most of it is protected functionalities to serve the generated
17/// binding classes that inherit from it.
18/// </summary>
13public abstract class EoWrapper : IWrapper, IDisposable 19public abstract class EoWrapper : IWrapper, IDisposable
14{ 20{
21 /// <summary>Object used to synchronize access to EFL events.</summary>
15 protected readonly object eflBindingEventLock = new object(); 22 protected readonly object eflBindingEventLock = new object();
16 private bool generated = true; 23 private bool generated = true;
17 private System.IntPtr handle = IntPtr.Zero; 24 private System.IntPtr handle = IntPtr.Zero;
@@ -49,7 +56,7 @@ public abstract class EoWrapper : IWrapper, IDisposable
49 /// <summary>Initializes a new instance of the <see cref="Object"/> class. 56 /// <summary>Initializes a new instance of the <see cref="Object"/> class.
50 /// Internal usage: Constructs an instance from a native pointer. This is used when interacting with C code and should not be used directly. 57 /// Internal usage: Constructs an instance from a native pointer. This is used when interacting with C code and should not be used directly.
51 /// Do not implement this constructor.</summary> 58 /// Do not implement this constructor.</summary>
52 /// <param name="raw">The native pointer to be wrapped.</param> 59 /// <param name="wh">The native pointer to be wrapped.</param>
53 protected EoWrapper(Efl.Eo.Globals.WrappingHandle wh) 60 protected EoWrapper(Efl.Eo.Globals.WrappingHandle wh)
54 { 61 {
55 handle = wh.NativeHandle; 62 handle = wh.NativeHandle;
@@ -124,6 +131,15 @@ public abstract class EoWrapper : IWrapper, IDisposable
124 get; 131 get;
125 } 132 }
126 133
134 /// <summary>
135 /// Whether this object type is one of the generated binding classes or a custom
136 /// class defined by the user and that inherit from one of the generated ones.
137 /// </summary>
138 /// <returns>
139 /// True if this object type is one of the generated binding classes,
140 /// false if it is class that is manually defined and that inherits from
141 /// one of the generated ones, including user defined classes.
142 /// </returns>
127 protected bool IsGeneratedBindingClass 143 protected bool IsGeneratedBindingClass
128 { 144 {
129 get { return generated; } 145 get { return generated; }
@@ -269,7 +285,7 @@ public abstract class EoWrapper : IWrapper, IDisposable
269 ws.MakeShared(); 285 ws.MakeShared();
270 } 286 }
271 287
272 /// <sumary>Create and set to the internal native state a C# supervisor for this Eo wrapper. For internal use only.</sumary> 288 /// <summary>Create and set to the internal native state a C# supervisor for this Eo wrapper. For internal use only.</summary>
273 private void AddWrapperSupervisor() 289 private void AddWrapperSupervisor()
274 { 290 {
275 var ws = new Efl.Eo.WrapperSupervisor(this); 291 var ws = new Efl.Eo.WrapperSupervisor(this);
@@ -291,16 +307,24 @@ public abstract class EoWrapper : IWrapper, IDisposable
291 Eina.Error.RaiseIfUnhandledException(); 307 Eina.Error.RaiseIfUnhandledException();
292 } 308 }
293 309
310 /// <summary>
311 /// Struct to be used when constructing objects from native code.
312 /// Wraps the pointer handle to the native object instance.
313 /// </summary>
294 protected struct ConstructingHandle 314 protected struct ConstructingHandle
295 { 315 {
316 /// <summary>Constructor for wrapping the native handle.</summary>
296 public ConstructingHandle(IntPtr h) 317 public ConstructingHandle(IntPtr h)
297 { 318 {
298 NativeHandle = h; 319 NativeHandle = h;
299 } 320 }
300 321
322 /// <summary>Pointer to the native instance.</summary>
301 public IntPtr NativeHandle { get; private set; } 323 public IntPtr NativeHandle { get; private set; }
302 } 324 }
303 325
326 /// <summary>Wrapper for native methods and virtual method delegates.
327 /// For internal use by generated code only.</summary>
304 public abstract class NativeMethods : Efl.Eo.NativeClass 328 public abstract class NativeMethods : Efl.Eo.NativeClass
305 { 329 {
306 private static EflConstructorDelegate csharpEflConstructorStaticDelegate = new EflConstructorDelegate(Constructor); 330 private static EflConstructorDelegate csharpEflConstructorStaticDelegate = new EflConstructorDelegate(Constructor);
@@ -308,6 +332,8 @@ public abstract class EoWrapper : IWrapper, IDisposable
308 332
309 private delegate IntPtr EflConstructorDelegate(IntPtr obj, IntPtr pd); 333 private delegate IntPtr EflConstructorDelegate(IntPtr obj, IntPtr pd);
310 334
335 /// <summary>Gets the list of Eo operations to override.</summary>
336 /// <returns>The list of Eo operations to be overload.</returns>
311 public override System.Collections.Generic.List<Efl_Op_Description> GetEoOps(Type type) 337 public override System.Collections.Generic.List<Efl_Op_Description> GetEoOps(Type type)
312 { 338 {
313 var descs = new System.Collections.Generic.List<Efl_Op_Description>(); 339 var descs = new System.Collections.Generic.List<Efl_Op_Description>();
diff --git a/src/bindings/mono/eo_mono/iwrapper.cs b/src/bindings/mono/eo_mono/iwrapper.cs
index 7c2eeb4..833ae78 100644
--- a/src/bindings/mono/eo_mono/iwrapper.cs
+++ b/src/bindings/mono/eo_mono/iwrapper.cs
@@ -716,11 +716,11 @@ public class Globals
716 Monitor.Exit(Efl.All.InitLock); 716 Monitor.Exit(Efl.All.InitLock);
717 } 717 }
718 718
719 /// <sumary> 719 /// <summary>
720 /// Internal struct used by the binding to pass the native handle pointer 720 /// Internal struct used by the binding to pass the native handle pointer
721 /// to the managed object wrapping constructor. 721 /// to the managed object wrapping constructor.
722 /// Internal usage only: do not use this class in inherited classes. 722 /// Internal usage only: do not use this class in inherited classes.
723 /// </sumary> 723 /// </summary>
724 public struct WrappingHandle 724 public struct WrappingHandle
725 { 725 {
726 public WrappingHandle(IntPtr h) 726 public WrappingHandle(IntPtr h)