Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Open sidebar
Martin Finkel
LibVLCSharp
Commits
17260136
Commit
17260136
authored
Feb 19, 2019
by
Martin Finkel
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Fix LibVLC ctor comment formmating. Lots of text and too much spaces made it unreadable in VS
parent
c2427206
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
30 deletions
+30
-30
LibVLCSharp/Shared/LibVLC.cs
LibVLCSharp/Shared/LibVLC.cs
+30
-30
No files found.
LibVLCSharp/Shared/LibVLC.cs
View file @
17260136
...
...
@@ -149,41 +149,41 @@ namespace LibVLCSharp.Shared
}
/// <summary>
///
<para>
Create and initialize a libvlc instance.
</para>
///
<para>
This functions accept a list of "command line" arguments similar to the
</para>
///
<para>
main(). These arguments affect the LibVLC instance default configuration.
</para>
///
<para>
LibVLC may create threads. Therefore, any thread-unsafe process
</para>
///
<para>
initialization must be performed before calling libvlc_new(). In particular
</para>
///
<para>
and where applicable:
</para>
/// Create and initialize a libvlc instance.
/// This functions accept a list of "command line" arguments similar to the
/// main(). These arguments affect the LibVLC instance default configuration.
/// LibVLC may create threads. Therefore, any thread-unsafe process
/// initialization must be performed before calling libvlc_new(). In particular
/// and where applicable:
/// <para>- setlocale() and textdomain(),</para>
/// <para>- setenv(), unsetenv() and putenv(),</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>- sigprocmask() shall never be invoked; pthread_sigmask() can be used.</para>
///
<para>
On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the
</para>
///
<para>
signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
</para>
///
<para>
Also while LibVLC is active, the wait() function shall not be called, and
</para>
///
<para>
any call to waitpid() shall use a strictly positive value for the first
</para>
///
<para>
parameter (i.e. the PID). Failure to follow those rules may lead to a
</para>
///
<para>
deadlock or a busy loop.
</para>
///
<para>
Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
</para>
///
<para>
even if it is not, in principles, necessary, e.g.:
</para>
///
<para>
On Microsoft Windows Vista/2008, the process error mode
</para>
///
<para>
SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.
</para>
///
<para>
On later versions, that is optional and unnecessary.
</para>
///
<para>
Also on Microsoft Windows (Vista and any later version), setting the default
</para>
///
<para>
DLL directories to SYSTEM32 exclusively is strongly recommended for
</para>
///
<para>
security reasons:
</para>
///
<para>
Arguments are meant to be passed from the command line to LibVLC, just like
</para>
///
<para>
VLC media player does. The list of valid arguments depends on the LibVLC
</para>
///
<para>
version, the operating system and platform, and set of available LibVLC
</para>
///
<para>
plugins. Invalid or unsupported arguments will cause the function to fail
</para>
///
<para>
(i.e. return NULL). Also, some arguments may alter the behaviour or
</para>
///
<para>
otherwise interfere with other LibVLC functions.
</para>
///
<para>
There is absolutely no warranty or promise of forward, backward and
</para>
///
<para>
cross-platform compatibility with regards to libvlc_new() arguments.
</para>
///
<para>
We recommend that you do not use them, other than when debugging.
</para>
/// On POSIX systems, the SIGCHLD signalmust notbe ignored, i.e. the
/// signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
/// Also while LibVLC is active, the wait() function shall not be called, and
/// any call to waitpid() shall use a strictly positive value for the first
/// parameter (i.e. the PID). Failure to follow those rules may lead to a
/// deadlock or a busy loop.
/// Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
/// even if it is not, in principles, necessary, e.g.:
/// On Microsoft Windows Vista/2008, the process error mode
/// SEM_FAILCRITICALERRORS flagmustbe set before using LibVLC.
/// On later versions, that is optional and unnecessary.
/// Also on Microsoft Windows (Vista and any later version), setting the default
/// DLL directories to SYSTEM32 exclusively is strongly recommended for
/// security reasons:
/// Arguments are meant to be passed from the command line to LibVLC, just like
/// VLC media player does. The list of valid arguments depends on the LibVLC
/// version, the operating system and platform, and set of available LibVLC
/// plugins. Invalid or unsupported arguments will cause the function to fail
/// (i.e. return NULL). Also, some arguments may alter the behaviour or
/// otherwise interfere with other LibVLC functions.
/// There is absolutely no warranty or promise of forward, backward and
/// cross-platform compatibility with regards to libvlc_new() arguments.
/// We recommend that you do not use them, other than when debugging.
/// </summary>
/// <param name="options">list of arguments (should be NULL)</param>
/// <returns>the libvlc instance or NULL in case of error</returns>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment