[gst-devel] state of gst-cvs

[Stefan Kost]

Hi Wim,

Wim Taymans wrote:
> On Mon, 2005-09-19 at 22:22 +0200, Stefan Kost wrote:
> 
>>hi,
>>
>><3 lines with agressive content deleted>
>>
>>Can we please be a bit more communicative. IMHO its a bit
>>unproffesional, if I update gst-cvs and all of a sudden stuff fails to
>>compiles here and there. Why can't such changes be announced on the
>>mailing list?
>>
>>And for the GstBus change - Fix the fucking docs please! Is that soooooo
>>difficult?
>>
>>--- docs/gst/gstreamer-sections.txt     15 Sep 2005 00:42:03 -0000     
>>1.169
>>+++ docs/gst/gstreamer-sections.txt     19 Sep 2005 20:18:44 -0000
>>@@ -83,7 +83,7 @@
>> GstBus
>> GstBusFlags
>> GstBusSyncReply
>>-GstBusHandler
>>+GstBusFunc
>> GstBusSyncHandler
>> gst_bus_new
>> gst_bus_post
> 
> 
> Sorry, I missed that one, was focused on the inline API docs. We should
> get to a point where not updating the docs in _all_ places should simply
> make the build fail.
> 
> Wim 
> 
Again sorry if the mail sounded harsh, but I tok my 3 hour yerterday to get my 
project back to compile :(

Unfortunately we are far from getting the docs to build without warnings. Look 
at (both files should ideally be empty):
* docs/gst/gstreamer-unused.txt
   symbols in here have docs, but are not yet entered into the
   gstreamer-section.txt file, thus it does not appear in the docs.
* docs/gst/gstreamer-undocumented.txt
   symbols here have no docs yet, there are two cases:
   * internal symbols, which are uninteresting for the developer
   * public api
   The internal one only need to be move to the private subsection inside
   the section.txt file. The public ones need docs.

My plan regarding the docs is to inline the remaining 5-10 files (moved docs 
from tmpl-files to inline comments). I would appreaciate if anyone who stumbled 
upon undocumented api where he knows what it is about to add a doc-comment.
Right now we have 372 undocumented api entries.

Stefan