docs: fix some warnings and add some since markers
authorTim-Philipp Müller <tim@centricular.com>
Thu, 31 Dec 2015 19:27:12 +0000 (19:27 +0000)
committerTim-Philipp Müller <tim@centricular.com>
Sun, 3 Jan 2016 17:50:35 +0000 (17:50 +0000)
docs/gst/gstreamer-sections.txt
gst/gstbuffer.h
gst/gstpad.c
gst/gstpad.h
gst/gsttracer.c
gst/gsttracerfactory.c
gst/gsttracerfactory.h

index 6ba3254..369db8f 100644 (file)
@@ -1855,6 +1855,8 @@ gst_pad_probe_info_get_query
 GST_PAD_PROBE_INFO_OFFSET
 GST_PAD_PROBE_INFO_SIZE
 
+GST_PAD_PROBE_INFO_FLOW_RETURN
+
 GstPadProbeCallback
 gst_pad_add_probe
 gst_pad_remove_probe
index f52fe91..da9a033 100644 (file)
@@ -99,6 +99,8 @@ typedef struct _GstBufferPool GstBufferPool;
  *
  * Returns the buffer decoding timestamp (dts) if valid, else the buffer
  * presentation time (pts)
+ *
+ * Since: 1.8
  */
 #define GST_BUFFER_DTS_OR_PTS(buf)              (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
 /**
index aed3af7..7cbdae9 100644 (file)
@@ -1853,6 +1853,8 @@ event_wrap (GstPad * pad, GstObject * object, GstEvent * event)
  * @notify: notify called when @event will not be used anymore.
  *
  * Sets the given event handler for the pad.
+ *
+ * Since: 1.8
  */
 void
 gst_pad_set_event_full_function_full (GstPad * pad,
@@ -6136,7 +6138,7 @@ gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
  * gst_pad_probe_info_get_buffer_list:
  * @info: a #GstPadProbeInfo
  *
- * Returns: (transfer none): The #GstBufferlist from the probe
+ * Returns: (transfer none): The #GstBufferList from the probe
  */
 
 GstBufferList *
index 20fd9a2..4a465c9 100644 (file)
@@ -378,6 +378,8 @@ typedef gboolean            (*GstPadEventFunction)          (GstPad *pad, GstObject *parent,
  *
  * Returns: %GST_FLOW_OK if the event was handled properly, or any other
  * #GstFlowReturn dependent on downstream state.
+ *
+ * Since: 1.8
  */
 typedef GstFlowReturn          (*GstPadEventFullFunction)      (GstPad *pad, GstObject *parent,
                                                                  GstEvent *event);
@@ -910,6 +912,8 @@ struct _GstPadClass {
  * use this to set your own event handling function on a pad
  * after you create it.  If your element derives from a base
  * class, use the base class's virtual functions instead.
+ *
+ * Since: 1.8
  */
 #define GST_PAD_EVENTFULLFUNC(pad)     (GST_PAD_CAST(pad)->ABI.abi.eventfullfunc)
 /**
index 668b98a..f1806f6 100644 (file)
@@ -27,6 +27,8 @@
  * gst_tracer_register(). Modules can attach to various hook-types - see
  * #GstTracerHook. When invoked they receive hook specific contextual data, 
  * which they must not modify.
+ *
+ * Since: 1.8
  */
 
 #define GST_USE_UNSTABLE_API
index ec7ba53..65fd066 100644 (file)
@@ -67,6 +67,8 @@ gst_tracer_factory_init (GstTracerFactory * factory)
  *
  * Returns: (transfer full) (element-type Gst.TracerFactory): the list of all
  *     registered #GstTracerFactory.
+ *
+ * Since: 1.8
  */
 GList *
 gst_tracer_factory_get_list (void)
index 09d357f..aa09635 100644 (file)
@@ -40,6 +40,8 @@ G_BEGIN_DECLS
  * GstTracerFactory:
  *
  * Opaque object that stores information about a tracer function.
+ *
+ * Since: 1.8
  */
 typedef struct _GstTracerFactory GstTracerFactory;
 typedef struct _GstTracerFactoryClass GstTracerFactoryClass;