After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 124213 - [docs/gtkdoc] *-sections.txt should be autogenerated
[docs/gtkdoc] *-sections.txt should be autogenerated
Status: RESOLVED NOTABUG
Product: GStreamer
Classification: Platform
Component: documentation
git master
Other Linux
: Normal normal
: git master
Assigned To: Stefan Sauer (gstreamer, gtkdoc dev)
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2003-10-09 13:36 UTC by Benjamin Otte (Company)
Modified: 2005-08-18 07:46 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Benjamin Otte (Company) 2003-10-09 13:36:10 UTC 
CVS contains {gstreamer,gst-libs,...}-sections.txt files which are a list
of all features that need to be documented.
This means API additions must be added manually to this list.
This in turn means that not adding them manually doesn't make them show up
as undocumented.

As the *-sections.txt files are normally autogenerated from gtk-doc it
should be possible to make a list of non-documented features and remove
them from the autogenerated list.

How do other gtk-doc projects do it?
Comment 1 David Schleef 2003-10-24 23:45:56 UTC 
gtk keeps it in CVS.  Presumably they generate it periodically --
gtk-doc only creates it if it is missing.  Existing files are left
untouched.
Comment 2 Andy Wingo 2005-07-14 18:04:19 UTC 
Assigning to Stefan Kost, muahaha!
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2005-07-14 18:47:36 UTC 
These files are not autogenerated. One (unfortunately) need to fill them by hand. 
This bug should be closed in favour of an RFE for gtk-doc.

Apart gtk-doc already lists docs comments it find when scanning in the unused
file. It is then a matter to put these into the right place inside the section
file. I am not sure if gtk-doc can be smart enough to always figure out where
they should go.
Comment 4 Benjamin Otte (Company) 2005-07-15 11:45:11 UTC 
It must be possible to get around having to edit the -sections file everytime
some API is added. It should be possible to have a useful default behaviour.
Feel free to move this bug to gtk-doc if it's more appropriate there.
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2005-07-15 13:39:22 UTC 
moved to http://bugzilla.gnome.org/show_bug.cgi?id=310494
please close this bug and comment and/or cc yourself to there