[gst-devel] Python GStreamer API doc

[Stefan Kost]

Hi Edward & Gian Mario,

in case a new feature of gtk-odc here and there would help you to generate the 
docs just let me know. Mean if there are some missing information in the 
generated files that you need and so on.

Stefan

Edward Hervey wrote:
> Hi,
> 
> On 1/15/06, Gian Mario Tagliaretti <g.tagliaretti at gmail.com> wrote:
> 
>>>>unluckyly everything is done with the old school.... "by hand" :)
>>
>>>  Argh :) Have you tried using the templates generated by the
>>>gstreamer core doc build ? It could give a head start, and then it
>>>would just mean replacing the "C" arguments/comments with the python
>>>ones....
>>
>>I wrote some other docs in the recent past [1] and I've tried to use
>>the C docs but without any success, great ideas are welcome anyway :p
> 
> 
>   I was thinking something in more or less the same logic as the
> codegenerator and the overrides. That is:
> 
>   _ [A] Use the gtk-doc data and the .defs files as base material
> (using some scripts to convert the methods/functions/arguments names
> and types to the python equivalent), to generate most of the
> documentation
>   _ [B] Have some overrides to document the overrides : because the
> given functions/methods have overrides, because they raise exceptions
> if something goes wrong, for added methods specific to gst-python,
> etc....
> 
>   That would mean that most of the work would have to be done for [B]
> once the scripts for [A] are done.
> 
>   Any comments ?
> 
> 
>>[1] http://www.pygtk.org/reference.html
>>
>>ciao
>>--
>>Gian Mario Tagliaretti
>>PyGTK GUI programming
>>http://www.parafernalia.org/pygtk/
>>
> 
> 
> 
> --
> Edward Hervey
> Junior developer / Fluendo S.L.
> http://www.pitivi.org/
> N�HY޵隊X���'���u���[�������
> ަ�k��!���W�~�鮆�zk��C�	塧m����@^ǚ��^��z�Z�f�z�
j�!�x2�������ɫ,���a{��,�H��4�m���i�(��ܢo�v'��jYhr'ׯ:�rX��-��z�^��fj)b�	b��,������z�+-��.�ǟ��
��a��l��b��,���y�+��޷�b��?�+-�w��-��z�^vel=