python bindings: documentation update

diff --git a/bindings/python/vlc_input.c b/bindings/python/vlc_input.c
index 939acc11f67c7a8cf926c86466ed12fe3f048f4b..2dd74697b4c59dc5d67ceaecf3c3d44f469f27fd 100644 (file)
--- a/bindings/python/vlc_input.c
+++ b/bindings/python/vlc_input.c
@@ -212,7 +212,7 @@ static PyTypeObject vlcInput_Type =
     0,                         /*tp_setattro*/
     0,                         /*tp_as_buffer*/
     Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
-    "vlc.Input object",  /* tp_doc */
+    "vlc.Input object\n\nIt cannot be instanciated standalone, it must be obtained from an existing vlc.Instance object",  /* tp_doc */
     0,                        /* tp_traverse */
     0,                        /* tp_clear */
     0,                         /* tp_richcompare */

diff --git a/bindings/python/vlc_instance.c b/bindings/python/vlc_instance.c
index f3b82514f0e8f98e82608d69b8feaf1bff3afdbc..1e419644390e7ea700e290680288ff7eb2a0b912 100644 (file)
--- a/bindings/python/vlc_instance.c
+++ b/bindings/python/vlc_instance.c
@@ -711,7 +711,7 @@ static PyTypeObject vlcInstance_Type =
     0,                         /*tp_setattro*/
     0,                         /*tp_as_buffer*/
     Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
-    "VLC Instance.",  /* tp_doc */
+    "VLC Instance(args)\n\nNote: if args is specified, the first arg is interpreted as an executable name to get the directory of the VLC plugins.",  /* tp_doc */
     0,                     /* tp_traverse */
     0,                     /* tp_clear */
     0,                     /* tp_richcompare */

diff --git a/bindings/python/vlc_mediacontrol.c b/bindings/python/vlc_mediacontrol.c
index 910384c7d7e3693069659ba2104252fade4c5f4a..bf4203688d101f5ab3b8e83b5ea20ba6fb10f311 100644 (file)
--- a/bindings/python/vlc_mediacontrol.c
+++ b/bindings/python/vlc_mediacontrol.c
@@ -667,7 +667,7 @@ static PyTypeObject MediaControl_Type =
     0,                         /*tp_setattro*/
     0,                         /*tp_as_buffer*/
     Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
-    "Control of a VLC instance.",  /* tp_doc */
+    "Control of a VLC instance.\n\nvlc.MediaControl(args): initialisation with a list of VLC parameters.\nvlc.MediaControl(instance): initialisation with an existing vlc.Instance",  /* tp_doc */
     0,                     /* tp_traverse */
     0,                     /* tp_clear */
     0,                     /* tp_richcompare */

diff --git a/bindings/python/vlc_object.c b/bindings/python/vlc_object.c
index 068ab310329b1714edbec2a8b9e7d7a17050f707..e3043cfc42137f1076d921e24439ffb8288f894e 100644 (file)
--- a/bindings/python/vlc_object.c
+++ b/bindings/python/vlc_object.c
@@ -595,7 +595,7 @@ static PyTypeObject vlcObject_Type =
     0,                         /*tp_setattro*/
     0,                         /*tp_as_buffer*/
     Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
-    "Expose VLC object infrastructure.",  /* tp_doc */
+    "Expose VLC object infrastructure.\n\nConstructor: vlc.Object(object_id)",  /* tp_doc */
     0,                     /* tp_traverse */
     0,                     /* tp_clear */
     0,                     /* tp_richcompare */