Browse Source

python bindings: documentation update

pull/2/head
Olivier Aubert 20 years ago
parent
commit
53af6645dd
  1. 2
      bindings/python/vlc_input.c
  2. 2
      bindings/python/vlc_instance.c
  3. 2
      bindings/python/vlc_mediacontrol.c
  4. 2
      bindings/python/vlc_object.c

2
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 */

2
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 */

2
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 */

2
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 */

Loading…
Cancel
Save