[gst-devel] gstreamer-section.txt cleanup

Stefan Kost kost at imn.htwk-leipzig.de
Tue May 18 10:11:17 CEST 2004


hi all,

currently gtk-doc reports
66% symbol docs coverage
942 symbols documented
488 not documented

among those 488 are things like
GST_OBJECT_CLASS

I have looked how glib and gtk handled the standard gobject stuff.
They usually put them to the <SUBSECTION Standard>. This ensures that the
hierarchy work, but does not put the symbol into the documentation (and
therefore does not warn).

1.) I would like to add some guidelines to the README in docs/
2.) I volunteer to cleanup the gstreamer-sections.txt a bit

Any pros and cons?

Stefan

PS.: have a look at gstreamer-undocumented.txt from time to time. For those who
introduced the symbols it is easier to decide, what to do with the symbol
(document it, hide it by move to standard or even private section)
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -
-------------- next part --------------
A non-text attachment was scrubbed...
Name: kost.vcf
Type: text/x-vcard
Size: 345 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/gstreamer-devel/attachments/20040518/225c3798/attachment.vcf>


More information about the gstreamer-devel mailing list