Changeset 53af6645ddc6b6031e9ea7145bb419b6ad384730

Show
Ignore:
Timestamp:
26/09/06 17:16:00 (2 years ago)
Author:
Olivier Aubert <olivier.aubert@liris.cnrs.fr>
git-committer:
Olivier Aubert <olivier.aubert@liris.cnrs.fr> 1159283760 +0000
git-parent:

[90d263973597139605a42f6b32afa80e85a3d1e7]

git-author:
Olivier Aubert <olivier.aubert@liris.cnrs.fr> 1159283760 +0000
Message:

python bindings: documentation update

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • bindings/python/vlc_input.c

    r07a52db r53af664  
    213213    0,                         /*tp_as_buffer*/ 
    214214    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ 
    215     "vlc.Input object",  /* tp_doc */ 
     215    "vlc.Input object\n\nIt cannot be instanciated standalone, it must be obtained from an existing vlc.Instance object",  /* tp_doc */ 
    216216    0,                        /* tp_traverse */ 
    217217    0,                        /* tp_clear */ 

  • bindings/python/vlc_instance.c

    r07a52db r53af664  
    712712    0,                         /*tp_as_buffer*/ 
    713713    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ 
    714     "VLC Instance.",  /* tp_doc */ 
     714    "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 */ 
    715715    0,                     /* tp_traverse */ 
    716716    0,                     /* tp_clear */ 

  • bindings/python/vlc_mediacontrol.c

    r07a52db r53af664  
    668668    0,                         /*tp_as_buffer*/ 
    669669    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ 
    670     "Control of a VLC instance.",  /* tp_doc */ 
     670    "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 */ 
    671671    0,                     /* tp_traverse */ 
    672672    0,                     /* tp_clear */ 

  • bindings/python/vlc_object.c

    r07a52db r53af664  
    596596    0,                         /*tp_as_buffer*/ 
    597597    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ 
    598     "Expose VLC object infrastructure.",  /* tp_doc */ 
     598    "Expose VLC object infrastructure.\n\nConstructor: vlc.Object(object_id)",  /* tp_doc */ 
    599599    0,                     /* tp_traverse */ 
    600600    0,                     /* tp_clear */