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 /// Native string buffer, similar to the C# StringBuilder class. /// -/// Since EFL 1.23. +/// Since EFL 1.23. /// public class Strbuf : IDisposable { - ///Pointer to the underlying native handle. + ///Pointer to the underlying native handle. + /// Since EFL 1.23. + /// + [EditorBrowsable(EditorBrowsableState.Never)] public IntPtr Handle { get; protected set; } private Ownership Ownership; private bool Disposed; - ///Creates a new Strbuf. By default its lifetime is managed. + ///Creates a new Strbuf. By default its lifetime is managed. + /// Since EFL 1.23. + /// public Strbuf(Ownership ownership = Ownership.Managed) { this.Handle = eina_strbuf_new(); this.Ownership = ownership; } - ///Creates a new Strbuf from an existing IntPtr. + ///Creates a new Strbuf from an existing IntPtr. + /// Since EFL 1.23. + /// + [EditorBrowsable(EditorBrowsableState.Never)] public Strbuf(IntPtr ptr, Ownership ownership) { this.Handle = ptr; this.Ownership = ownership; } - /// Releases the ownership of the underlying value to C. + /// Releases the ownership of the underlying value to C. + /// Since EFL 1.23. + /// + [EditorBrowsable(EditorBrowsableState.Never)] public void ReleaseOwnership() { this.Ownership = Ownership.Unmanaged; } - /// Takes the ownership of the underlying value to the Managed runtime. + /// Takes the ownership of the underlying value to the Managed runtime. + /// Since EFL 1.23. + /// + [EditorBrowsable(EditorBrowsableState.Never)] public void TakeOwnership() { this.Ownership = Ownership.Managed; } - ///Public method to explicitly free the wrapped buffer. + ///Public method to explicitly free the wrapped buffer. + /// Since EFL 1.23. + /// public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } - ///Actually free the wrapped buffer. Can be called from Dispose() or through the GC. + ///Actually free the wrapped buffer. Can be called from Dispose() or through the Garbage Collector. + /// Since EFL 1.23. + /// protected virtual void Dispose(bool disposing) { if (this.Ownership == Ownership.Unmanaged) @@ -120,13 +139,18 @@ public class Strbuf : IDisposable Disposed = true; } - ///Finalizer to be called from the GC. + ///Finalizer to be called from the Garbage Collector. + /// Since EFL 1.23. + /// ~Strbuf() { Dispose(false); } - ///Retrieves the length of the buffer contents. + ///Retrieves the length of the buffer contents. + /// Since EFL 1.23. + /// + /// The number of characters in this buffer. public int Length { get @@ -136,7 +160,9 @@ public class Strbuf : IDisposable } } - ///Resets a string buffer. Its len is set to 0 and the content to '\\0' + ///Resets a string buffer. Its len is set to 0. + /// Since EFL 1.23. + /// public void Reset() { if (Disposed) @@ -147,7 +173,11 @@ public class Strbuf : IDisposable eina_strbuf_reset(Handle); } - ///Appends a string to a buffer, reallocating as necessary. + ///Appends a string to a buffer, reallocating as necessary. + /// Since EFL 1.23. + /// + /// The string to be appended. + /// true if the append was successful. public bool Append(string text) { if (Disposed) @@ -158,7 +188,11 @@ public class Strbuf : IDisposable return eina_strbuf_append(Handle, text); } - ///Appens an escaped string to a buffer, reallocating as necessary. + ///Appends an escaped string to a buffer, reallocating as necessary. + /// Since EFL 1.23. + /// + /// The string to be escaped and appended. + /// true if the append was successful. public bool AppendEscaped(string text) { if (Disposed) @@ -169,7 +203,11 @@ public class Strbuf : IDisposable return eina_strbuf_append_escaped(Handle, text); } - ///Appends a char to a buffer, reallocating as necessary. + ///Appends a char to a buffer, reallocating as necessary. + /// Since EFL 1.23. + /// + /// The character to be appended. + /// true if the append was successful. public bool Append(char c) { if (Disposed) @@ -180,7 +218,10 @@ public class Strbuf : IDisposable return eina_strbuf_append_char(Handle, c); } - ///Steals the content of a buffer. + ///Steals the content of a buffer. This causes the buffer to be re-initialized. + /// Since EFL 1.23. + /// + /// A string with the contents of this buffer. public string Steal() { if (Disposed) @@ -191,7 +232,10 @@ public class Strbuf : IDisposable return eina_strbuf_string_steal(this.Handle); } - /// Copy the content of a buffer. + /// Copy the content of a buffer. + /// Since EFL 1.23. + /// + /// A string with the contents of this buffer. public override string ToString() { if (Disposed)