[gstreamer-bugs] [Bug 341527] New: API documentation and inline documentation

[GStreamer (bugzilla.gnome.org)]

Do not reply to this via email (we are currently unable to handle email
responses and they get discarded).  You can add comments to this bug at
http://bugzilla.gnome.org/show_bug.cgi?id=341527
 GStreamer | gst-python | Ver: HEAD CVS

           Summary: API documentation and inline documentation
           Product: GStreamer
           Version: HEAD CVS
          Platform: Other
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: enhancement
          Priority: Normal
         Component: gst-python
        AssignedTo: gstreamer-bugs at lists.sourceforge.net
        ReportedBy: bilboed at bilboed.com
         QAContact: johan at gnome.org
     GNOME version: Unspecified
   GNOME milestone: Unspecified


It's about time we satisfy all python devs who want to use gst-python out there
with good pythonic documentation.

Two things needed:
_A/ inline documentation (pydoc gst). The reason we don't do that, is because
it would increase the memory usage when loading gstpython. All the same, we
should look into it. The new pygtk codegenerator allows to inline documentation
in the .defs.

_B/ pygtk-like html documentation (see
http://pygtk.org/pygtk2reference/index.html). Some work was already started
here : http://pygstdocs.berlios.de/

We should look into using both the codegenerator and the
gstreamer/docs/gst/*.xml to help use generate that.


-- 
Configure bugmail: http://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.