docs: fix some warnings and add some since markers

This commit is contained in:
Tim-Philipp Müller 2015-12-31 19:27:12 +00:00
parent 1205a04a25
commit 7c992cfbe0
7 changed files with 17 additions and 1 deletions

View file

@ -1855,6 +1855,8 @@ gst_pad_probe_info_get_query
GST_PAD_PROBE_INFO_OFFSET GST_PAD_PROBE_INFO_OFFSET
GST_PAD_PROBE_INFO_SIZE GST_PAD_PROBE_INFO_SIZE
GST_PAD_PROBE_INFO_FLOW_RETURN
GstPadProbeCallback GstPadProbeCallback
gst_pad_add_probe gst_pad_add_probe
gst_pad_remove_probe gst_pad_remove_probe

View file

@ -99,6 +99,8 @@ typedef struct _GstBufferPool GstBufferPool;
* *
* Returns the buffer decoding timestamp (dts) if valid, else the buffer * Returns the buffer decoding timestamp (dts) if valid, else the buffer
* presentation time (pts) * 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)) #define GST_BUFFER_DTS_OR_PTS(buf) (GST_BUFFER_DTS_IS_VALID(buf) ? GST_BUFFER_DTS(buf) : GST_BUFFER_PTS (buf))
/** /**

View file

@ -1853,6 +1853,8 @@ event_wrap (GstPad * pad, GstObject * object, GstEvent * event)
* @notify: notify called when @event will not be used anymore. * @notify: notify called when @event will not be used anymore.
* *
* Sets the given event handler for the pad. * Sets the given event handler for the pad.
*
* Since: 1.8
*/ */
void void
gst_pad_set_event_full_function_full (GstPad * pad, 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: * gst_pad_probe_info_get_buffer_list:
* @info: a #GstPadProbeInfo * @info: a #GstPadProbeInfo
* *
* Returns: (transfer none): The #GstBufferlist from the probe * Returns: (transfer none): The #GstBufferList from the probe
*/ */
GstBufferList * GstBufferList *

View 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 * Returns: %GST_FLOW_OK if the event was handled properly, or any other
* #GstFlowReturn dependent on downstream state. * #GstFlowReturn dependent on downstream state.
*
* Since: 1.8
*/ */
typedef GstFlowReturn (*GstPadEventFullFunction) (GstPad *pad, GstObject *parent, typedef GstFlowReturn (*GstPadEventFullFunction) (GstPad *pad, GstObject *parent,
GstEvent *event); GstEvent *event);
@ -910,6 +912,8 @@ struct _GstPadClass {
* use this to set your own event handling function on a pad * use this to set your own event handling function on a pad
* after you create it. If your element derives from a base * after you create it. If your element derives from a base
* class, use the base class's virtual functions instead. * class, use the base class's virtual functions instead.
*
* Since: 1.8
*/ */
#define GST_PAD_EVENTFULLFUNC(pad) (GST_PAD_CAST(pad)->ABI.abi.eventfullfunc) #define GST_PAD_EVENTFULLFUNC(pad) (GST_PAD_CAST(pad)->ABI.abi.eventfullfunc)
/** /**

View file

@ -27,6 +27,8 @@
* gst_tracer_register(). Modules can attach to various hook-types - see * gst_tracer_register(). Modules can attach to various hook-types - see
* #GstTracerHook. When invoked they receive hook specific contextual data, * #GstTracerHook. When invoked they receive hook specific contextual data,
* which they must not modify. * which they must not modify.
*
* Since: 1.8
*/ */
#define GST_USE_UNSTABLE_API #define GST_USE_UNSTABLE_API

View file

@ -67,6 +67,8 @@ gst_tracer_factory_init (GstTracerFactory * factory)
* *
* Returns: (transfer full) (element-type Gst.TracerFactory): the list of all * Returns: (transfer full) (element-type Gst.TracerFactory): the list of all
* registered #GstTracerFactory. * registered #GstTracerFactory.
*
* Since: 1.8
*/ */
GList * GList *
gst_tracer_factory_get_list (void) gst_tracer_factory_get_list (void)

View file

@ -40,6 +40,8 @@ G_BEGIN_DECLS
* GstTracerFactory: * GstTracerFactory:
* *
* Opaque object that stores information about a tracer function. * Opaque object that stores information about a tracer function.
*
* Since: 1.8
*/ */
typedef struct _GstTracerFactory GstTracerFactory; typedef struct _GstTracerFactory GstTracerFactory;
typedef struct _GstTracerFactoryClass GstTracerFactoryClass; typedef struct _GstTracerFactoryClass GstTracerFactoryClass;