[vlc-commits] commit: Warn about libvlc_new() arguments ( Rémi Denis-Courmont )

[git at videolan.org]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Tue Aug 10 18:23:31 2010 +0300| [424a8584663cdf330ce47c1e480f610d8728a711] | committer: Rémi Denis-Courmont 

Warn about libvlc_new() arguments

Those are not part of the API and ABI compatibility "promise"

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=424a8584663cdf330ce47c1e480f610d8728a711
---

 include/vlc/libvlc.h |   19 +++++++++++++++++--
 1 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 36b263f..dbc70d2 100644
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -112,9 +112,24 @@ const char *libvlc_printerr (const char *fmt, ...);
 
 /**
  * Create and initialize a libvlc instance.
- *
- * \param argc the number of arguments
- * \param argv command-line-type arguments
+ * This functions accept a list of "command line" arguments similar to the
+ * main(). These arguments affect the LibVLC instance default configuration.
+ *
+ * \version
+ * 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.
+ *
+ * \warning
+ * 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.
+ *
+ * \param argc the number of arguments (should be 0)
+ * \param argv list of arguments (should be NULL)
  * \return the libvlc instance or NULL in case of error
  */
 VLC_PUBLIC_API libvlc_instance_t *