Commit 247431e0 authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

Documentation

parent b651213d
......@@ -67,10 +67,10 @@ namespace VideoLAN.LibVLC
};
/**
* @brief BaseObject: generic wrapper around a safe handle.
* @brief BaseObject: generic wrapper around a safe LibVLC handle.
* @ingroup Internals
* This is the baseline for all managed LibVLC objects which wrap
* an unmanaged LibVLC pointer.
* an unmanaged LibVLC pointer, and provides exception handling.
*/
public class BaseObject : IDisposable
{
......@@ -101,6 +101,11 @@ namespace VideoLAN.LibVLC
GC.SuppressFinalize (this);
}
/**
* Releases unmanaged resources associated with the object.
* @param disposing true if the disposing the object explicitly,
* false if finalizing the object inside the GC.
*/
protected virtual void Dispose (bool disposing)
{
if (disposing)
......
......@@ -114,6 +114,10 @@ namespace VideoLAN.LibVLC
return U8String.FromNative (handle);
}
/**
* Converts the buffer (as in ToString()) and release it.
* @return managed string representation of the buffer
*/
public string Transform ()
{
string value = ToString ();
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment