[gst-devel] apidoc : gstenumtypes

Stefan Kost kost at imn.htwk-leipzig.de
Thu Dec 30 03:46:08 CET 2004

Hi all,

I have removed the gstenumtypes from the docs. While doing that I noticed that
all enums where documented in the sgml file and not in the source. The advantage
of this is, that when changing the docs, source doe not need to be rebuild (as
no header file is changed). Unfortunately thata the only advantage.
The disadvantages are:
1) I had to copy the documentation fragments to about 15 other files manually.
2) When one adds a new member to an enum, often the docs are not updated. If the
doc comments would be right above the enum, chances would be better that the new
 member would get a docs.

So I like to ask developers to add comments to the source whenever possible. If
I have overseen anything, please correct me. If there is aggreement I update the
README in docs as well.

Here is a short list of entries that I would like to fix, please reply with the
docs and I put them in:

gstpad.h : GstPadFlags
gstevent.h : GstFlags::Navigation,Tag
gstplugin.h : GstPluginError::NameMismatch
gsttypes.h : GstResult
gstthread.h : GstThreadState::Waiting
gstscheduler.h : GstSchedulerFlags::NewAPI

Many thanks

Stefan Kost wrote:
> hi hi,
> we currently have all gst-core enumerations collected on one page. I managed to
> fix the page so that it is not empty anymore. Unfortunately this causes a
> problem. gtkdoc does not likes it, when symbols appear more that one in the docs
> (e.g. GstBufferFlags, once in the gstbuffer page and once on the enumtypes page).
> Question: do we need such a page (enumtypes), or can I just drop it?
> Stefan
> PS.: happy x-mas to all of you!

      \|/            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/20041230/625fb5cd/attachment.vcf>

More information about the gstreamer-devel mailing list