[857/906] display: document the new GstContext api

diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c
index 7a0b161a3d8b0b9b4051cc645c18cfee11b19acd..16863faa6e708af1da1e31ebda5776ed05d99135 100644 (file)
--- a/gst-libs/gst/gl/gstgldisplay.c
+++ b/gst-libs/gst/gl/gstgldisplay.c
@@ -21,6 +21,17 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gstgldisplay
+ * @short_description: window system display connection abstraction
+ * @title: GstGLDisplay
+ * @see_also: #GstContext, #GstGLContext, #GstGLWindow
+ *
+ * #GstGLDisplay represents a connection to the underlying windowing system. 
+ * Elements are required to make use of #GstContext to share and propogate
+ * a #GstGLDisplay.
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -103,6 +114,13 @@ gst_gl_display_get_gl_api (GstGLDisplay * display)
   return gst_gl_context_get_gl_api (display->context);
 }
 
+/**
+ * gst_context_set_gl_display:
+ * @context: a #GstContext
+ * @display: resulting #GstGLDisplay
+ *
+ * Sets @display on @context
+ */
 void
 gst_context_set_gl_display (GstContext * context, GstGLDisplay * display)
 {
@@ -118,6 +136,13 @@ gst_context_set_gl_display (GstContext * context, GstGLDisplay * display)
       display, NULL);
 }
 
+/**
+ * gst_context_get_gl_display:
+ * @context: a #GstContext
+ * @display: resulting #GstGLDisplay
+ *
+ * Returns: Whether @display was in @context
+ */
 gboolean
 gst_context_get_gl_display (GstContext * context, GstGLDisplay ** display)
 {

diff --git a/gst-libs/gst/gl/gstgldisplay.h b/gst-libs/gst/gl/gstgldisplay.h
index 9fb22f54f46a003e3bb8ab459700178c7811ba18..a0178e46e1ee931f6f1b87950df8ccf52e40b4ec 100644 (file)
--- a/gst-libs/gst/gl/gstgldisplay.h
+++ b/gst-libs/gst/gl/gstgldisplay.h
@@ -42,14 +42,14 @@ GType gst_gl_display_get_type (void);
 /**
  * GstGLDisplay:
  *
- * the contents of a #GstGLDisplay are private and should only be accessed
+ * The contents of a #GstGLDisplay are private and should only be accessed
  * through the provided API
  */
 struct _GstGLDisplay
 {
+  /* <private> */
   GstObject             object;
 
-  /* <private> */
   GstGLContext         *context;
   GstGLAPI              gl_api;