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 559135 - Add five more opengl elements to plugin docs
Add five more opengl elements to plugin docs
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gst-plugins-gl
git master
Other Linux
: Normal enhancement
: 0.10.2
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2008-11-03 16:18 UTC by Tristan Matthews
Modified: 2009-07-29 23:39 UTC
See Also:
GNOME target: ---
GNOME version: 2.23/2.24



Description Tristan Matthews 2008-11-03 16:18:09 UTC
The main gstreamer website doesn't have any links to the gst-plugins-gl module.
Here are some relevant links: 
http://fargiolas.netsons.org/2008/08/final-soc-report-screencasts-screencasts-screencasts/

and the git repository:
git://diracvideo.org/git/gst-plugins-gl.git
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2009-01-25 16:47:50 UTC
What if we move them back to fdo, now that gstreamer uses git as well?
Comment 2 David Schleef 2009-01-25 20:18:31 UTC
bilboed was waiting for any issues related to the main git trees to settle down before moving anything else.
Comment 3 Edward Hervey 2009-01-26 09:44:35 UTC
ok, I'll clone it on freedesktop/gstreamer once I've fixed a few things.
Comment 4 Edward Hervey 2009-01-29 10:39:26 UTC
move done. Does the website actually need anything ?
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2009-01-30 16:12:02 UTC
I think it should be added to
http://gstreamer.freedesktop.org/modules/
(while doing that should we remove gst-recorder and gst-monkeysaudio)?

If the docs build is working we could add links on
http://gstreamer.freedesktop.org/documentation/
Comment 6 Julien Isorce 2009-07-27 08:59:16 UTC

I only see 11 elements there:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-gl-plugins/html/

but it exists 16 elements. I think something is wrong in the gtk-doc configuration files in gst-plugins-gl.
Whereas doc exists in top of the C files of those elements.

Is someone able to fix that ?
Comment 7 Stefan Sauer (gstreamer, gtkdoc dev) 2009-07-27 14:06:54 UTC
Are you checking the build output:

./gst-plugins-gl-plugins-unused.txt:1: warning: 12 unused declarations.They should be added to gst-plugins-gl-plugins-sections.txt in the appropriate place.
GstGLBumperClass
GstGLColorscaleClass
GstGLDownloadClass
GstGLEffectsClass
GstGLFilterAppClass
GstGLFilterCubeClass
GstGLFilterGlassClass
GstGLFilterLaplacianClass
GstGLImageSinkClass
GstGLTestSrcClass
GstGLUploadClass
gst_gl_effects_xray
*** Building XML ***
63% symbol docs coverage (50 symbols documented, 0 symbols incomplete, 29 not documented)
See gst-plugins-gl-plugins-undocumented.txt for a list of missing docs.

Also see docs/plugins/gst-plugins-gl-plugins-undocumented.txt
Comment 8 Tim-Philipp Müller 2009-07-29 09:34:37 UTC
Ok, so the docs for these 5 elements need to be hooked up in the right places, changing bug description accordingly:

  gldeinterlace
  glfiltersobel
  glfilterblur
  gldifferencematte
  gloverlay

If you want to give it a shot yourself, check out the appropriate section in gstreamer/docs/README for info on how to hook it up.
Comment 9 Tim-Philipp Müller 2009-07-29 23:39:08 UTC
I think this should fix it:

 commit d8826559d638cbad1ad5984a988823ec120061a7
 Author: Tim-Philipp Müller <tim.muller@collabora.co.uk>
 Date:   Thu Jul 30 00:36:30 2009 +0100

    docs: make remaining elements show up in docs
    
    Split out declarations into header files and hook everything up so
    that five more elements show up in the plugin docs. Fixes #559135.