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 697920 - Some of (at least) -base/gst-libs/gst/audio/audio-format.h misses out on html documentation
Some of (at least) -base/gst-libs/gst/audio/audio-format.h misses out on html...
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
1.0.6
Other Linux
: Normal normal
: 1.1.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2013-04-12 22:03 UTC by Douglas Bagnall
Modified: 2013-04-17 08:49 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Douglas Bagnall 2013-04-12 22:03:58 UTC 
https://www.google.com/search?q=GST_AUDIO_CAPS_MAKE reveals no documentation for GST_AUDIO_CAPS_MAKE() (though it does show numerous examples).

This is defined in gst-plugins-base/gst-libs/gst/audio/audio-format.h, which is included in gst-plugins-base/gst-libs/gst/audio/audio.h.

Looking at http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudio.html, it seems that some definitions from audio-format.h are documented here (for example, the GstAudioFormat enum, and all(?) functions), while others are not.

Without having a clue or being systematic, it seems as if gtk-doc gave up on #defines at around line 273.
Comment 1 Tim-Philipp Müller 2013-04-17 08:49:35 UTC 
It's not that gtk-doc "gave up", but either the macro is not listed in the docs/libs/gst-plugins-base-sections.txt file, or there's no gtk-doc chunk for it in the code.


commit e96ca66c36f86cf6edd5723fa2f69d8aa222466d
Author: Tim-Philipp Müller <tim@centricular.net>
Date:   Wed Apr 17 09:23:20 2013 +0100

    docs: add some more audio macros