gst: Documentation fixes
authorEdward Hervey <edward@centricular.com>
Mon, 2 Apr 2018 10:42:30 +0000 (12:42 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Mon, 2 Apr 2018 10:42:30 +0000 (12:42 +0200)
* Fix copy-paste error for GstParamSpecArray documentation
* Use proper field name for tracer utils documentation

gst/gstparamspecs.h
gst/gsttracerutils.h

index 1d69f95..4f5d8e3 100644 (file)
@@ -118,10 +118,9 @@ struct _GstParamSpecFraction {
 /**
  * GstParamSpecArray:
  * @parent_instance: super class
- * @value_array: the array of values
+ * @element_spec: the #GParamSpec of the type of values in the array
  *
- * A GParamSpec derived structure that contains the meta data for fractional
- * properties.
+ * A GParamSpec derived structure for arrays of values.
  */
 struct _GstParamSpecArray {
   GParamSpec    parent_instance;
index bbb1a0d..a2a5ed6 100644 (file)
@@ -600,7 +600,7 @@ typedef void (*GstTracerHookMiniObjectDestroyed) (GObject *self, GstClockTime ts
  * @self: the tracer instance
  * @ts: the current timestamp
  * @object: the object being unreffed
- * @refcount: the new refcount after unrefing @object
+ * @new_refcount: the new refcount after unrefing @object
  *
  * Hook called when a #GstObject is being unreffed named
  * "object-unreffed"
@@ -617,7 +617,7 @@ typedef void (*GstTracerHookObjectUnreffed) (GObject *self, GstClockTime ts,
  * @self: the tracer instance
  * @ts: the current timestamp
  * @object: the object being reffed
- * @refcount: the new refcount after refing @object
+ * @new_refcount: the new refcount after refing @object
  *
  * Hook called when a #GstObject is being reffed named
  * "object-reffed".
@@ -634,7 +634,7 @@ typedef void (*GstTracerHookObjectReffed) (GObject *self, GstClockTime ts,
  * @self: the tracer instance
  * @ts: the current timestamp
  * @object: the mini object being unreffed
- * @refcount: the new refcount after unrefing @object
+ * @new_refcount: the new refcount after unrefing @object
  *
  * Hook called when a #GstMiniObject is being unreffed named
  * "mini-object-unreffed".
@@ -651,7 +651,7 @@ typedef void (*GstTracerHookMiniObjectUnreffed) (GObject *self, GstClockTime ts,
  * @self: the tracer instance
  * @ts: the current timestamp
  * @object: the mini object being reffed
- * @refcount: the new refcount after refing @object
+ * @new_refcount: the new refcount after refing @object
  *
  * Hook called when a #GstMiniObject is being reffed named
  * "mini-object-reffed".