Commit 708049c3 authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

Fix documentation

parent d1324549
......@@ -60,11 +60,8 @@ namespace VideoLAN.LibVLC
};
/**
* @section Internals
*/
/**
* libvlc_exception_t: structure for unmanaged LibVLC exceptions
* @brief NativeException: CIL representation for libvlc_exception_t.
* @ingroup Internals
*/
[StructLayout (LayoutKind.Sequential)]
public sealed class NativeException : IDisposable
......
......@@ -36,6 +36,9 @@ namespace VideoLAN.LibVLC
*/
internal sealed class InstanceHandle : NonNullHandle
{
/**
* NonNullHandle.Destroy
*/
protected override void Destroy ()
{
LibVLC.Release (handle, null);
......
......@@ -50,6 +50,9 @@ namespace VideoLAN.LibVLC
}
}
/**
* Destroys an handle. Cannot fail.
*/
protected abstract void Destroy ();
/**
......@@ -80,6 +83,10 @@ namespace VideoLAN.LibVLC
this.handle = null;
}
/**
* Checks if the LibVLC run-time raised an exception
* If so, raises a CIL exception.
*/
protected void Raise ()
{
ex.Raise ();
......
......@@ -33,6 +33,9 @@ namespace VideoLAN.LibVLC
*/
internal sealed class MediaHandle : NonNullHandle
{
/**
* NonNullHandle.Destroy
*/
protected override void Destroy ()
{
LibVLC.MediaRelease (handle);
......@@ -41,7 +44,8 @@ namespace VideoLAN.LibVLC
/**
* @brief Media: a source media
* Use this class to extract meta-informations from a media.
* @ingroup API
* Each media object represents an input media, such as a file or an URL.
*/
public class Media : BaseObject
{
......@@ -67,6 +71,19 @@ namespace VideoLAN.LibVLC
Raise ();
}
/**
* Add VLC input item options to the media.
* @param options VLC options in VLC input item format
* (see example below)
* @param trusted whether the options are set by a trusted agent
* (e.g. the local computer configuration) or not
* (e.g. a downloaded file).
* @code
* Media m = new Media(vlc, "http://www.example.com/music.ogg");
* m.AddOptions(":http-user-agent=LibVLC.Net "
* + ":http-proxy=proxy:8080", true);
* @endcode
*/
public void AddOptions (string options, bool trusted)
{
U8String uopts = new U8String (options);
......
......@@ -68,6 +68,7 @@ namespace VideoLAN.LibVLC
/**
* @brief MediaPlayer: a simple media player
* @ingroup API
* Use this class to play a media.
*/
public class MediaPlayer : BaseObject
......
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