doc fixes

Original commit message from CVS:
doc fixes
parent e8dd138e
2005-06-29 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstbasesrc.sgml:
* gst/gstelement.c:
* gst/gstelement.h:
* gst/gstevent.c:
* gst/gstutils.c:
doc fixes
2005-06-29 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* docs/manual/advanced-autoplugging.xml:
......
......@@ -1733,8 +1733,8 @@ GstBaseSrc
GstBaseSrcClass
GstBaseSrcFlags
gst_basesrc_is_live
gst_basesrc_set_live
gst_base_src_is_live
gst_base_src_set_live
GST_BASESRC_PAD
<SUBSECTION Standard>
......@@ -1745,7 +1745,7 @@ GST_BASESRC_CLASS
GST_IS_BASESRC_CLASS
GST_BASESRC_GET_CLASS
<SUBSECTION Private>
gst_basesrc_get_type
gst_base_src_get_type
</SECTION>
......@@ -1767,7 +1767,7 @@ GST_BASESINK_CLASS
GST_IS_BASESINK_CLASS
GST_BASESINK_GET_CLASS
<SUBSECTION Private>
gst_basesink_get_type
gst_base_sink_get_type
</SECTION>
<SECTION>
......
......@@ -76,6 +76,24 @@ GstBaseSrc
@GST_BASESRC_STARTED:
@GST_BASESRC_FLAG_LAST:
<!-- ##### FUNCTION gst_base_src_is_live ##### -->
<para>
</para>
@src:
@Returns:
<!-- ##### FUNCTION gst_base_src_set_live ##### -->
<para>
</para>
@src:
@live:
<!-- ##### MACRO GST_BASESRC_PAD ##### -->
<para>
......
......@@ -441,6 +441,8 @@ Sets the parent of an element.
</para>
@element:
@scheduler:
<!-- # Unused Parameters # -->
@sched:
......
......@@ -1177,9 +1177,7 @@ gst_element_get_query_types (GstElement * element)
/**
* gst_element_query:
* @element: a #GstElement to perform the query on.
* @type: the #GstQueryType.
* @format: the #GstFormat pointer to hold the format of the result.
* @value: the pointer to the value of the result.
* @query: the #GstQuery.
*
* Performs a query on the given element. If the format is set
* to GST_FORMAT_DEFAULT and this function returns TRUE, the
......
......@@ -113,13 +113,13 @@ typedef enum
/**
* GST_ELEMENT_ERROR:
* @el: the element that throws the error
* @el: the element that throws the error
* @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
* @code: error code defined for that domain (see #GstError)
* @message: the message to display (format string and args enclosed in
parentheses)
* @debug: debugging information for the message (format string and args
enclosed in parentheses)
* @code: error code defined for that domain (see #GstError)
* @text: the message to display (format string and args enclosed in
parentheses)
* @debug: debugging information for the message (format string and args
enclosed in parentheses)
*
* Utility function that elements can use in case they encountered a fatal
* data processing error. The pipeline will throw an error signal and the
......@@ -292,7 +292,7 @@ void gst_element_set_manager (GstElement * element, GstPipeline * pipeline);
GstPipeline * gst_element_get_manager (GstElement * element);
void gst_element_set_bus (GstElement * element, GstBus * bus);
GstBus * gst_element_get_bus (GstElement * element);
void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
void gst_element_set_scheduler (GstElement *element, GstScheduler *scheduler);
GstScheduler* gst_element_get_scheduler (GstElement *element);
/* pad management */
......
......@@ -296,9 +296,10 @@ gst_event_new_discontinuous (gdouble rate, GstFormat format1, ...)
* gst_event_discont_get_value:
* @event: The event to query
* @format: The format of the discontinuous value
* @value: A pointer to the value
* @start_value: A pointer to store the end value in
* @end_value: A pointer to store the end value in
*
* Get the value for the given format in the discontinous event.
* Get the start and end value for the given format in the discontinous event.
*
* Returns: TRUE if the discontinuous event carries the specified
* format/value pair.
......
......@@ -577,7 +577,7 @@ gst_element_request_compatible_pad (GstElement * element,
* gst_element_get_compatible_pad:
* @element: a #GstElement in which the pad should be found.
* @pad: the #GstPad to find a compatible one for.
* @filtercaps: the #GstCaps to use as a filter.
* @caps: the #GstCaps to use as a filter.
*
* Looks for an unlinked pad to which the given pad can link. It is not
* guaranteed that linking the pads will work, though it should work in most
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment