using System;
using System.Runtime.InteropServices;
+using System.ComponentModel;
namespace Eina
{
/// <summary>
/// Manage the initialization and cleanup for eina.
-///
-/// Since EFL 1.23.
+/// <para>Since EFL 1.23.</para>
/// </summary>
public class Config
{
[DllImport(efl.Libs.Eina)] private static extern int eina_init();
[DllImport(efl.Libs.Eina)] private static extern int eina_shutdown();
+ /// <summary>
+ /// Initialize the Eina library.
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
public static void Init()
{
if (eina_init() == 0)
}
}
+ /// <summary>
+ /// Finalize the Eina library.
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
public static int Shutdown()
{
return eina_shutdown();
/// <summary>
/// Wrapper class for pointers that need some cleanup afterwards like strings
-///
-/// Since EFL 1.23.
+/// <para>Since EFL 1.23.</para>
/// </summary>
public class DisposableIntPtr : IDisposable
{
+ [EditorBrowsable(EditorBrowsableState.Never)]
public IntPtr Handle { get; set; }
private bool ShouldFree;
private bool Disposed;
/// <summary>Wraps a new ptr what will be freed based on the
- /// value of shouldFree</summary>
+ /// value of shouldFree
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
public DisposableIntPtr(IntPtr ptr, bool shouldFree = false)
{
Handle = ptr;
ShouldFree = shouldFree;
}
+
+ /// <summary>Release the native resources held by this instance.
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
+ /// <summary>Disposes of this wrapper, releasing the native handle if
+ /// owned.
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
+ /// <param name="disposing">True if this was called from <see cref="Dispose()"/> public method. False if
+ /// called from the C# finalizer.</param>
protected virtual void Dispose(bool disposing)
{
if (!Disposed && ShouldFree)
Disposed = true;
}
+
+ /// <summary>Release the native resources held by this instance.
+ /// <para>Since EFL 1.23.</para>
+ /// </summary>
~DisposableIntPtr()
{
Dispose(false);