gl/docs: massive update

- add Since: markers where necessary.
- document structs
- add documentation headers for each module (short_description,
  see_also, etc)
- reduce the number of warnings gtk-doc outputs
- fix spelling mistakes

2 files changed, 23 insertions, 12 deletions

diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml
index 0d0b95cbd..872846b72 100644
--- a/docs/libs/gst-plugins-bad-libs-docs.sgml
+++ b/docs/libs/gst-plugins-bad-libs-docs.sgml
@@ -72,6 +72,10 @@
 
     <chapter id="gl">
       <title>OpenGL Helper Library</title>
+      <para>
+        This library should be linked to by getting cflags and libs from
+        <filename>gstreamer-gl-&GST_API_VERSION;.pc</filename>
+      </para>
       <xi:include href="xml/gstglapi.xml"/>
       <xi:include href="xml/gstglbasefilter.xml"/>
       <xi:include href="xml/gstglbasememory.xml"/>
@@ -79,20 +83,22 @@
       <xi:include href="xml/gstglbufferpool.xml"/>
       <xi:include href="xml/gstglcolorconvert.xml"/>
       <xi:include href="xml/gstglcontext.xml"/>
-<!--      <xi:include href="xml/gstglcontextcocoa.xml"/>
+      <!-- Not exposed as public API
+      <xi:include href="xml/gstglcontextcocoa.xml"/>
       <xi:include href="xml/gstglcontexteagl.xml"/>
       <xi:include href="xml/gstglcontextegl.xml"/>
       <xi:include href="xml/gstglcontextglx.xml"/>
-      <xi:include href="xml/gstglcontextwgl.xml"/>-->
-      <xi:include href="xml/gstgldebug.xml"/>
+      <xi:include href="xml/gstglcontextwgl.xml"/>
+      -->
       <xi:include href="xml/gstgldisplay.xml"/>
-<!--      <xi:include href="xml/gstgldisplaycocoa.xml"/>
-      <xi:include href="xml/gstgldisplayegl.xml"/>-->
+      <!-- Not exposed as public API
+      <xi:include href="xml/gstgldisplaycocoa.xml"/>
+      <xi:include href="xml/gstgldisplayegl.xml"/>
+      -->
       <xi:include href="xml/gstgldisplaywayland.xml"/>
       <xi:include href="xml/gstgldisplayx11.xml"/>
       <xi:include href="xml/gsteglimage.xml"/>
       <xi:include href="xml/gstglfilter.xml"/>
-      <xi:include href="xml/gstglformat.xml"/>
       <xi:include href="xml/gstglframebuffer.xml"/>
       <xi:include href="xml/gstglmemory.xml"/>
       <xi:include href="xml/gstglmemoryegl.xml"/>
@@ -107,13 +113,18 @@
       <xi:include href="xml/gstglupload.xml"/>
       <xi:include href="xml/gstglviewconvert.xml"/>
       <xi:include href="xml/gstglwindow.xml"/>
-<!--      <xi:include href="xml/gstglwindowandroid.xml"/>
+      <!-- Not exposed as public API
+      <xi:include href="xml/gstglwindowandroid.xml"/>
       <xi:include href="xml/gstglwindowcocoa.xml"/>
       <xi:include href="xml/gstglwindowdispmanx.xml"/>
       <xi:include href="xml/gstglwindoweagl.xml"/>
       <xi:include href="xml/gstglwindowwayland.xml"/>
       <xi:include href="xml/gstglwindowwin32.xml"/>
-      <xi:include href="xml/gstglwindowx11.xml"/>-->
+      <xi:include href="xml/gstglwindowx11.xml"/>
+      -->
+      <!-- Some utilities -->
+      <xi:include href="xml/gstgldebug.xml"/>
+      <xi:include href="xml/gstglformat.xml"/>
       <xi:include href="xml/gstglutils.xml"/>
     </chapter>
 
diff --git a/docs/libs/gst-plugins-bad-libs-sections.txt b/docs/libs/gst-plugins-bad-libs-sections.txt
index 5a99c4844..77092f943 100644
--- a/docs/libs/gst-plugins-bad-libs-sections.txt
+++ b/docs/libs/gst-plugins-bad-libs-sections.txt
@@ -1081,7 +1081,7 @@ gst_gl_display_egl_get_type
 
 <SECTION>
 <FILE>gstgldisplaywayland</FILE>
-<TITLE>GstGLDIsplayWayland</TITLE>
+<TITLE>GstGLDisplayWayland</TITLE>
 gst_gl_display_wayland_new
 gst_gl_display_wayland_new_with_display
 <SUBSECTION Standard>
@@ -1093,7 +1093,7 @@ GST_GL_DISPLAY_WAYLAND_CLASS
 
 <SECTION>
 <FILE>gstgldisplayx11</FILE>
-<TITLE>GstGLDIsplayX11</TITLE>
+<TITLE>GstGLDisplayX11</TITLE>
 gst_gl_display_x11_new
 gst_gl_display_x11_new_with_display
 <SUBSECTION Standard>
@@ -1525,11 +1525,10 @@ GST_GLSL_STAGE_GET_CLASS
 <FILE>gstglsyncmeta</FILE>
 <TITLE>GstGLSyncMeta</TITLE>
 GstGLSyncMeta
+gst_gl_sync_meta_get_info
 gst_buffer_add_gl_sync_meta
 gst_buffer_add_gl_sync_meta_full
 gst_buffer_get_gl_sync_meta
-gst_gl_sync_meta_api_get_type
-gst_gl_sync_meta_get_info
 gst_gl_sync_meta_set_sync_point
 gst_gl_sync_meta_wait
 gst_gl_sync_meta_wait_cpu
@@ -1537,6 +1536,7 @@ GST_BUFFER_POOL_OPTION_GL_SYNC_META
 <SUBSECTION Standard>
 GST_GL_SYNC_META_API_TYPE
 GST_GL_SYNC_META_INFO
+gst_gl_sync_meta_api_get_type
 </SECTION>
 
 <SECTION>