[gst-devel] Re: [gst-cvs] thomasvs gstreamer: gstreamer/ gstreamer/docs/devhelp/ gstreamer/docs/gst/tmpl/

[Wim Taymans]

On Sun, 2002-03-10 at 21:17, Thomas Vander Stichele wrote:
> > * Thomas Vander Stichele <thomasvs at users.sourceforge.net> [20020310 06:48]:
> > > say, can anyone make a judgment call on whether or not these .sgml files still
> > > need to be in cvs ???
> > ...
> > >     docs/gst/tmpl   : cothreads.sgml gstaggregator.sgml gstbin.sgml
> > ...
> > 
> > Yes, I think this is where much of the documentation text should go.
> > Seems like inline docs and doxygen usage would be more maintainable
> > though.
> 
> Ok, let me rephrase the original question ;)
> Since they seem to be auto-generated, because I personally don't edit 
> those files by hand, why do they need to be in cvs ?

The boilerplate for the template is autogenerated. You are then supposed
to add explanations for macros, enums and other stuff that cannot be
added to the code with current gtk-doc. Also the module explanations are
in those files. gtk-doc tries hard to keep the parts you edited and adds
new sections where appropriate.

Removing those files would basically mean that you only get the API docs
added to the .c files (right before the method definitions) which is
insufficient. 

So, don't remove those files, they contain valuable information.

Wim

> 
> Thomas
> 
> -- 
> 
> The Dave/Dina Project : future TV today ! - http://davedina.apestaart.org/
> <-*-                      -*->
> Come on baby take a walk with me honey
> Tell me who do you love
> Who do you love
> <-*- thomas at apestaart.org -*->
> URGent, the best radio on the Internet - 24/7 ! - http://urgent.rug.ac.be/
> 
> 
> _______________________________________________
> gstreamer-devel mailing list
> gstreamer-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/gstreamer-devel
> 
>