Commit 17260136 authored by Martin Finkel's avatar Martin Finkel

Docs: Fix LibVLC ctor comment formmating. Lots of text and too much spaces made it unreadable in VS

parent c2427206
...@@ -149,41 +149,41 @@ namespace LibVLCSharp.Shared ...@@ -149,41 +149,41 @@ namespace LibVLCSharp.Shared
} }
/// <summary> /// <summary>
/// <para>Create and initialize a libvlc instance.</para> /// Create and initialize a libvlc instance.
/// <para>This functions accept a list of &quot;command line&quot; arguments similar to the</para> /// This functions accept a list of &quot;command line&quot; arguments similar to the
/// <para>main(). These arguments affect the LibVLC instance default configuration.</para> /// main(). These arguments affect the LibVLC instance default configuration.
/// <para>LibVLC may create threads. Therefore, any thread-unsafe process</para> /// LibVLC may create threads. Therefore, any thread-unsafe process
/// <para>initialization must be performed before calling libvlc_new(). In particular</para> /// initialization must be performed before calling libvlc_new(). In particular
/// <para>and where applicable:</para> /// and where applicable:
/// <para>- setlocale() and textdomain(),</para> /// <para>- setlocale() and textdomain(),</para>
/// <para>- setenv(), unsetenv() and putenv(),</para> /// <para>- setenv(), unsetenv() and putenv(),</para>
/// <para>- with the X11 display system, XInitThreads()</para> /// <para>- with the X11 display system, XInitThreads()</para>
/// <para>(see also libvlc_media_player_set_xwindow()) and</para> /// (see also libvlc_media_player_set_xwindow()) and
/// <para>- on Microsoft Windows, SetErrorMode().</para> /// <para>- on Microsoft Windows, SetErrorMode().</para>
/// <para>- sigprocmask() shall never be invoked; pthread_sigmask() can be used.</para> /// <para>- sigprocmask() shall never be invoked; pthread_sigmask() can be used.</para>
/// <para>On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the</para> /// On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the
/// <para>signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.</para> /// signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
/// <para>Also while LibVLC is active, the wait() function shall not be called, and</para> /// Also while LibVLC is active, the wait() function shall not be called, and
/// <para>any call to waitpid() shall use a strictly positive value for the first</para> /// any call to waitpid() shall use a strictly positive value for the first
/// <para>parameter (i.e. the PID). Failure to follow those rules may lead to a</para> /// parameter (i.e. the PID). Failure to follow those rules may lead to a
/// <para>deadlock or a busy loop.</para> /// deadlock or a busy loop.
/// <para>Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,</para> /// Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
/// <para>even if it is not, in principles, necessary, e.g.:</para> /// even if it is not, in principles, necessary, e.g.:
/// <para>On Microsoft Windows Vista/2008, the process error mode</para> /// On Microsoft Windows Vista/2008, the process error mode
/// <para>SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.</para> /// SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.
/// <para>On later versions, that is optional and unnecessary.</para> /// On later versions, that is optional and unnecessary.
/// <para>Also on Microsoft Windows (Vista and any later version), setting the default</para> /// Also on Microsoft Windows (Vista and any later version), setting the default
/// <para>DLL directories to SYSTEM32 exclusively is strongly recommended for</para> /// DLL directories to SYSTEM32 exclusively is strongly recommended for
/// <para>security reasons:</para> /// security reasons:
/// <para>Arguments are meant to be passed from the command line to LibVLC, just like</para> /// Arguments are meant to be passed from the command line to LibVLC, just like
/// <para>VLC media player does. The list of valid arguments depends on the LibVLC</para> /// VLC media player does. The list of valid arguments depends on the LibVLC
/// <para>version, the operating system and platform, and set of available LibVLC</para> /// version, the operating system and platform, and set of available LibVLC
/// <para>plugins. Invalid or unsupported arguments will cause the function to fail</para> /// plugins. Invalid or unsupported arguments will cause the function to fail
/// <para>(i.e. return NULL). Also, some arguments may alter the behaviour or</para> /// (i.e. return NULL). Also, some arguments may alter the behaviour or
/// <para>otherwise interfere with other LibVLC functions.</para> /// otherwise interfere with other LibVLC functions.
/// <para>There is absolutely no warranty or promise of forward, backward and</para> /// There is absolutely no warranty or promise of forward, backward and
/// <para>cross-platform compatibility with regards to libvlc_new() arguments.</para> /// cross-platform compatibility with regards to libvlc_new() arguments.
/// <para>We recommend that you do not use them, other than when debugging.</para> /// We recommend that you do not use them, other than when debugging.
/// </summary> /// </summary>
/// <param name="options">list of arguments (should be NULL)</param> /// <param name="options">list of arguments (should be NULL)</param>
/// <returns>the libvlc instance or NULL in case of error</returns> /// <returns>the libvlc instance or NULL in case of error</returns>
......
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