csharp: updating eldbus_pending docs and hide api.
authorBruno da Silva Belo <brunodasilvabelo@gmail.com>
Thu, 17 Oct 2019 18:25:17 +0000 (15:25 -0300)
committerWonki Kim <wonki_.kim@samsung.com>
Mon, 11 Nov 2019 02:18:26 +0000 (11:18 +0900)
Summary: ref T8361

Reviewers: lauromoura, felipealmeida, segfaultxavi, woohyun

Reviewed By: lauromoura

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Maniphest Tasks: T8361

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

src/bindings/mono/eldbus_mono/eldbus_pending.cs

index 3570ca1..7fbaf62 100644 (file)
@@ -2,12 +2,14 @@
 
 using System;
 using System.Runtime.InteropServices;
+using System.ComponentModel;
 
 using static eldbus.EldbusPendingNativeFunctions;
 
 namespace eldbus
 {
 
+[EditorBrowsable(EditorBrowsableState.Never)]
 public static class EldbusPendingNativeFunctions
 {
     [DllImport(efl.Libs.Eldbus)] public static extern void
@@ -42,12 +44,15 @@ public static class EldbusPendingNativeFunctions
 }
 
 /// <summary>Represents a DBus pending.
-///
-/// Since EFL 1.23.
+/// <para>Since EFL 1.23.</para>
 /// </summary>
 public class Pending
 {
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public IntPtr Handle {get;set;} = IntPtr.Zero;
+    /// <summary>Whether this managed list owns the native one.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
     public bool Own {get;set;} = true;
 
     private void InitNew(IntPtr handle, bool own)
@@ -65,11 +70,17 @@ public class Pending
         }
     }
 
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public Pending(IntPtr handle, bool own)
     {
         InitNew(handle, own);
     }
 
+    /// <summary>
+    ///   Releases the native handler.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
+    /// <returns>The native handler.</returns>
     public IntPtr Release()
     {
         IntPtr h = Handle;
@@ -77,12 +88,22 @@ public class Pending
         return h;
     }
 
+    /// <summary>
+    ///   Cancel the pending message.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
     public void Cancel()
     {
         CheckHandle();
         eldbus_pending_cancel(Handle);
     }
 
+    /// <summary>
+    ///   Get the destination of the pending message.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
+    /// <returns>A string corresponding to the destination of the
+    /// message</returns>
     public string GetDestination()
     {
         CheckHandle();
@@ -90,6 +111,11 @@ public class Pending
         return Eina.StringConversion.NativeUtf8ToManagedString(ptr);
     }
 
+    /// <summary>
+    ///   Get the path of the pending message.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
+    /// <returns>A string corresponding to the path of the message.</returns>
     public string GetPath()
     {
         CheckHandle();
@@ -97,6 +123,12 @@ public class Pending
         return Eina.StringConversion.NativeUtf8ToManagedString(ptr);
     }
 
+    /// <summary>
+    ///   Get the interface of the pending message.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
+    /// <returns>A string corresponding to the interface of the
+    /// message.</returns>
     public string GetInterface()
     {
         CheckHandle();
@@ -104,6 +136,11 @@ public class Pending
         return Eina.StringConversion.NativeUtf8ToManagedString(ptr);
     }
 
+    /// <summary>
+    ///   Get the method of the pending message.
+    /// <para>Since EFL 1.23.</para>
+    /// </summary>
+    /// <returns>A string corresponding to the method of the message.</returns>
     public string GetMethod()
     {
         CheckHandle();