libs: Documentation fixes
authorEdward Hervey <edward@centricular.com>
Mon, 2 Apr 2018 10:41:48 +0000 (12:41 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Mon, 2 Apr 2018 10:41:48 +0000 (12:41 +0200)
* Symbols not properly exposed or wrongly named

libs/gst/base/gstaggregator.h
libs/gst/check/gstcheck.h

index 67d52dc..df4e8e3 100644 (file)
@@ -64,10 +64,11 @@ struct _GstAggregatorPad
 {
   GstPad                       parent;
 
+  /*< public >*/
   /* Protected by the OBJECT_LOCK */
   GstSegment segment;
 
-  /* < Private > */
+  /* < private > */
   GstAggregatorPadPrivate   *  priv;
 
   gpointer _gst_reserved[GST_PADDING];
@@ -131,7 +132,6 @@ gboolean    gst_aggregator_pad_is_eos       (GstAggregatorPad *  pad);
 /**
  * GstAggregator:
  * @srcpad: the aggregator's source pad
- * @segment: the output segment
  *
  * Aggregator base class object structure.
  */
@@ -139,6 +139,7 @@ struct _GstAggregator
 {
   GstElement               parent;
 
+  /*< public >*/
   GstPad                *  srcpad;
 
   /*< private >*/
@@ -203,6 +204,10 @@ struct _GstAggregator
  *                  based aggregation to occur. Defaults to returning
  *                  GST_CLOCK_TIME_NONE causing the element to wait for buffers
  *                  on all sink pads before aggregating.
+ * @create_new_pad: Optional.
+ *                  Called when a new pad needs to be created. Allows subclass that
+ *                  don't have a single sink pad template to provide a pad based
+ *                  on the provided information.
  * @update_src_caps: Lets subclasses update the #GstCaps representing
  *                   the src pad caps before usage.  The result should end up
  *                   in @ret. Return %GST_AGGREGATOR_FLOW_NEED_DATA to indicate that the
@@ -220,6 +225,8 @@ struct _GstAggregator
  *                     Setup the allocation parameters for allocating output
  *                     buffers. The passed in query contains the result of the
  *                     downstream allocation query.
+ * @propose_allocation: Optional.
+ *                     Allows the subclass to handle the allocation query from upstream.
  *
  * The aggregator base class will handle in a thread-safe way all manners of
  * concurrent flushes, seeks, pad additions and removals, leaving to the
index 94b8dae..65ae9f0 100644 (file)
@@ -88,7 +88,7 @@ GST_CHECK_API
 void gst_check_init (int *argc, char **argv[]);
 
 GST_CHECK_API
-GstCheckLogFilter * gst_check_add_log_filter (const gchar * log,
+GstCheckLogFilter * gst_check_add_log_filter (const gchar * log_domain,
     GLogLevelFlags log_level, GRegex * regex, GstCheckLogFilterFunc func,
     gpointer user_data, GDestroyNotify destroy_data);