[Bug 697920] New: Some of (at least) -base/gst-libs/gst/audio/audio-format.h misses out on html documentation

GStreamer (bugzilla.gnome.org) bugzilla at gnome.org
Fri Apr 12 15:04:03 PDT 2013


https://bugzilla.gnome.org/show_bug.cgi?id=697920
  GStreamer | documentation | 1.0.6

           Summary: Some of (at least)
                    -base/gst-libs/gst/audio/audio-format.h misses out on
                    html documentation
    Classification: Platform
           Product: GStreamer
           Version: 1.0.6
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: normal
          Priority: Normal
         Component: documentation
        AssignedTo: gstreamer-bugs at lists.freedesktop.org
        ReportedBy: douglas at halo.gen.nz
         QAContact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---


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.

-- 
Configure bugmail: https://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.


More information about the gstreamer-bugs mailing list