[gst-devel] completing the API docs
Stefan Kost
kost at imn.htwk-leipzig.de
Thu Aug 12 07:01:05 CEST 2004
Just the keep the topic active - in the last two weeks not a single undocumented
API entry has been resolved :-(
And some people already think about starting the 0.9 branch ...
Ciao
Stefan
Stefan Kost wrote:
> hi all,
>
> I've done another round of cleanups. The references from the manual and the pwg
> to the API docs are now working again.
>
> The API-docs itself are a bit huge, especially the list at:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer.html
>
> Please suggest me, about elements that should not appear in den public docs or
> should be moved to a subsection. You know, we can add chapter and subchapter as
> we like.
>
> And finally you can go on adding long descriptions to all those sections, where
> it still is missing.
>
> Lets get the number of undocumented entries under 200 before doing the next release!
>
> Ciao
> Stefan
>
> Stefan Kost wrote:
>
>>hi,
>>
>>I know I am a pest, but after cleaning up the section file, we have a quite
>>preceice log of undocumentetd public api entries in
>>docs/gst/gstreamer-undocumented.txt (nearly 400)
>>
>>1.) It would be good if you all could glimpse over it and if you find something
>>you remember that you have added it in the past (or know what it does), please
>>comment it! E.g. gst/gstvalue.c has even the documentation template in there,
>>they just need to be filled ;-).
>>A big batch are macros/defines (about 200) where we can move many of them to the
>>Standard/Private section, if you tell me these dont need to be documentend (like
>>e.g. GST_TYPE_.*)
>>
>>2.) Second what do we do with the GstElements in gstreamer core. Should we add
>>another section containing them (someone seem to had a go on this already - its
>>all commented out in the gstreamer-docs.sgml).
>>
>>3.) Same question for interfaces, schedulers (what elso do we have in quantities?)
>>
>>Stefan
>
>
--
\|/ 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/20040812/746ee152/attachment.vcf>
More information about the gstreamer-devel
mailing list