gl/docs: update some doc comments
authorMatthew Waters <matthew@centricular.com>
Wed, 18 Mar 2015 17:12:49 +0000 (10:12 -0700)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 9 Dec 2017 19:31:58 +0000 (19:31 +0000)
gst-libs/gst/gl/gstglbufferpool.c
gst-libs/gst/gl/gstglcolorconvert.c
gst-libs/gst/gl/gstglcontext.c
gst-libs/gst/gl/gstgldisplay.c
gst-libs/gst/gl/gstgldownload.c
gst-libs/gst/gl/gstglmemory.c
gst-libs/gst/gl/gstglupload.c

index 6dd496c..78c6a77 100644 (file)
@@ -326,7 +326,7 @@ gst_gl_buffer_pool_acquire_buffer (GstBufferPool * bpool,
 
 /**
  * gst_gl_buffer_pool_new:
- * @display: the #GstGLDisplay to use
+ * @context: the #GstGLContext to use
  *
  * Returns: a #GstBufferPool that allocates buffers with #GstGLMemory
  */
index 86906bb..95a0eb2 100644 (file)
@@ -625,8 +625,8 @@ _gst_gl_color_convert_set_caps_unlocked (GstGLColorConvert * convert,
 /**
  * gst_gl_color_convert_set_caps:
  * @convert: a #GstGLColorConvert
- * @in_info: input #GstVideoInfo
- * @out_info: output #GstVideoInfo
+ * @in_caps: input #GstCaps
+ * @out_caps: output #GstCaps
  *
  * Initializes @convert with the information required for conversion.
  */
index d05169f..b578a16 100644 (file)
@@ -449,7 +449,6 @@ gst_gl_context_get_current_gl_context (GstGLPlatform context_type)
 
 /**
  * gst_gl_context_get_current_gl_api:
- * @context_type: a #GstGLPlatform specifying the type of context to retreive
  * @major: (out): (allow-none): the major version
  * @minor: (out): (allow-none): the minor version
  *
index 89f22ea..6eb968d 100644 (file)
@@ -214,6 +214,7 @@ gst_gl_display_default_get_handle (GstGLDisplay * display)
 /**
  * gst_gl_display_filter_gl_api:
  * @display: a #GstGLDisplay
+ * @gl_api: a #GstGLAPI to filter with
  *
  * limit the use of OpenGL to the requested @gl_api.  This is intended to allow
  * application and elements to request a specific set of OpenGL API's based on
index d5b35c3..1ae49b8 100644 (file)
@@ -151,9 +151,7 @@ gst_gl_download_reset (GstGLDownload * download)
 /**
  * gst_gl_download_set_format:
  * @download: a #GstGLDownload
- * @v_format: a #GstVideoFormat
- * @out_width: the width to download to
- * @out_height: the height to download to
+ * @out_info: a #GstVideoInfo
  *
  * Initializes @download with the information required for download.
  */
index 397d216..911c48c 100644 (file)
@@ -1407,7 +1407,7 @@ gst_is_gl_memory (GstMemory * mem)
 /**
  * gst_gl_memory_setup_buffer:
  * @context: a #GstGLContext
- * @param: a #GstAllocationParams
+ * @params: a #GstAllocationParams
  * @info: a #GstVideoInfo
  * @valign: the #GstVideoAlignment applied to @info
  * @buffer: a #GstBuffer
index 635477f..9309b46 100644 (file)
@@ -984,8 +984,8 @@ gst_gl_upload_set_caps (GstGLUpload * upload, GstCaps * in_caps,
 /**
  * gst_gl_upload_get_caps:
  * @upload: a #GstGLUpload
- * @in_caps: (transfer full): (allow-none): (out): the input #GstCaps
- * @ou_caps: (transfer full): (allow-none): (out): the output #GstCaps
+ * @in_caps: (transfer full) (allow-none) (out): the input #GstCaps
+ * @out_caps: (transfer full) (allow-none) (out): the output #GstCaps
  *
  * Returns: (transfer none): The #GstCaps set by gst_gl_upload_set_caps()
  */