xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=15933eb37b258736619c27d7c8d93b2f38ba00f7
commit 15933eb37b258736619c27d7c8d93b2f38ba00f7 Author: Lauro Moura <[email protected]> Date: Thu Oct 10 10:26:24 2019 +0200 csharp: Fix doc and hide stuff from strbuf. Summary: ref T8293 Reviewers: felipealmeida, brunobelo, woohyun, segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8293 Differential Revision: https://phab.enlightenment.org/D10326 --- src/bindings/mono/eina_mono/eina_strbuf.cs | 76 +++++++++++++++++++++++------- 1 file changed, 60 insertions(+), 16 deletions(-) diff --git a/src/bindings/mono/eina_mono/eina_strbuf.cs b/src/bindings/mono/eina_mono/eina_strbuf.cs index 97664d9620..e4b6ab1eff 100644 --- a/src/bindings/mono/eina_mono/eina_strbuf.cs +++ b/src/bindings/mono/eina_mono/eina_strbuf.cs @@ -1,5 +1,6 @@ using System; using System.Runtime.InteropServices; +using System.ComponentModel; using static Eina.EinaNative.StrbufNativeMethods; @@ -52,49 +53,67 @@ static internal class StrbufNativeMethods /// <summary>Native string buffer, similar to the C# StringBuilder class. /// -/// Since EFL 1.23. +/// <para>Since EFL 1.23.</para> /// </summary> public class Strbuf : IDisposable { - ///<summary>Pointer to the underlying native handle.</summary> + ///<summary>Pointer to the underlying native handle. + /// <para>Since EFL 1.23.</para> + /// </summary> + [EditorBrowsable(EditorBrowsableState.Never)] public IntPtr Handle { get; protected set; } private Ownership Ownership; private bool Disposed; - ///<summary>Creates a new Strbuf. By default its lifetime is managed.</summary> + ///<summary>Creates a new Strbuf. By default its lifetime is managed. + /// <para>Since EFL 1.23.</para> + /// </summary> public Strbuf(Ownership ownership = Ownership.Managed) { this.Handle = eina_strbuf_new(); this.Ownership = ownership; } - ///<summary>Creates a new Strbuf from an existing IntPtr.</summary> + ///<summary>Creates a new Strbuf from an existing IntPtr. + /// <para>Since EFL 1.23.</para> + /// </summary> + [EditorBrowsable(EditorBrowsableState.Never)] public Strbuf(IntPtr ptr, Ownership ownership) { this.Handle = ptr; this.Ownership = ownership; } - /// <summary>Releases the ownership of the underlying value to C.</summary> + /// <summary>Releases the ownership of the underlying value to C. + /// <para>Since EFL 1.23.</para> + /// </summary> + [EditorBrowsable(EditorBrowsableState.Never)] public void ReleaseOwnership() { this.Ownership = Ownership.Unmanaged; } - /// <summary>Takes the ownership of the underlying value to the Managed runtime.</summary> + /// <summary>Takes the ownership of the underlying value to the Managed runtime. + /// <para>Since EFL 1.23.</para> + /// </summary> + [EditorBrowsable(EditorBrowsableState.Never)] public void TakeOwnership() { this.Ownership = Ownership.Managed; } - ///<summary>Public method to explicitly free the wrapped buffer.</summary> + ///<summary>Public method to explicitly free the wrapped buffer. + /// <para>Since EFL 1.23.</para> + /// </summary> public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } - ///<summary>Actually free the wrapped buffer. Can be called from Dispose() or through the GC.</summary> + ///<summary>Actually free the wrapped buffer. Can be called from Dispose() or through the Garbage Collector. + /// <para>Since EFL 1.23.</para> + /// </summary> protected virtual void Dispose(bool disposing) { if (this.Ownership == Ownership.Unmanaged) @@ -120,13 +139,18 @@ public class Strbuf : IDisposable Disposed = true; } - ///<summary>Finalizer to be called from the GC.</summary> + ///<summary>Finalizer to be called from the Garbage Collector. + /// <para>Since EFL 1.23.</para> + /// </summary> ~Strbuf() { Dispose(false); } - ///<summary>Retrieves the length of the buffer contents.</summary> + ///<summary>Retrieves the length of the buffer contents. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <value>The number of characters in this buffer.</value> public int Length { get @@ -136,7 +160,9 @@ public class Strbuf : IDisposable } } - ///<summary>Resets a string buffer. Its len is set to 0 and the content to '\\0'</summary> + ///<summary>Resets a string buffer. Its len is set to 0. + /// <para>Since EFL 1.23.</para> + /// </summary> public void Reset() { if (Disposed) @@ -147,7 +173,11 @@ public class Strbuf : IDisposable eina_strbuf_reset(Handle); } - ///<summary>Appends a string to a buffer, reallocating as necessary.</summary> + ///<summary>Appends a string to a buffer, reallocating as necessary. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <param name="text">The string to be appended.</param> + /// <returns><c>true</c> if the append was successful.</returns> public bool Append(string text) { if (Disposed) @@ -158,7 +188,11 @@ public class Strbuf : IDisposable return eina_strbuf_append(Handle, text); } - ///<summary>Appens an escaped string to a buffer, reallocating as necessary.</summary> + ///<summary>Appends an escaped string to a buffer, reallocating as necessary. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <param name="text">The string to be escaped and appended.</param> + /// <returns><c>true</c> if the append was successful.</returns> public bool AppendEscaped(string text) { if (Disposed) @@ -169,7 +203,11 @@ public class Strbuf : IDisposable return eina_strbuf_append_escaped(Handle, text); } - ///<summary>Appends a char to a buffer, reallocating as necessary.</summary> + ///<summary>Appends a char to a buffer, reallocating as necessary. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <param name="c">The character to be appended.</param> + /// <returns><c>true</c> if the append was successful.</returns> public bool Append(char c) { if (Disposed) @@ -180,7 +218,10 @@ public class Strbuf : IDisposable return eina_strbuf_append_char(Handle, c); } - ///<summary>Steals the content of a buffer.</summary> + ///<summary>Steals the content of a buffer. This causes the buffer to be re-initialized. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <returns>A string with the contents of this buffer.</returns> public string Steal() { if (Disposed) @@ -191,7 +232,10 @@ public class Strbuf : IDisposable return eina_strbuf_string_steal(this.Handle); } - /// <summary>Copy the content of a buffer.</summary> + /// <summary>Copy the content of a buffer. + /// <para>Since EFL 1.23.</para> + /// </summary> + /// <returns>A string with the contents of this buffer.</returns> public override string ToString() { if (Disposed) --
