More docs updates

Original commit message from CVS:
More docs updates
This commit is contained in:
Wim Taymans 2001-03-27 17:34:39 +00:00
parent 10e29412ff
commit 426ac6ae66
4 changed files with 165 additions and 104 deletions

View File

@ -619,6 +619,9 @@ gst_typefactory_save_thyself
<SECTION> <SECTION>
<FILE>gstcaps</FILE> <FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE> <TITLE>GstCaps</TITLE>
GST_CAPS_LOCK
GST_CAPS_TRYLOCK
GST_CAPS_UNLOCK
GstCaps GstCaps
GstCapsFactory GstCapsFactory
GstCapsFactoryEntry GstCapsFactoryEntry
@ -649,10 +652,12 @@ gst_caps_get_boolean
gst_caps_get_by_name gst_caps_get_by_name
gst_caps_get_fourcc_int gst_caps_get_fourcc_int
gst_caps_get_int gst_caps_get_int
gst_caps_get_string
gst_caps_save_thyself gst_caps_save_thyself
gst_caps_load_thyself gst_caps_load_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
GST_CAPS
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -667,6 +672,7 @@ GST_PROPS_INT_RANGE
GST_PROPS_FOURCC GST_PROPS_FOURCC
GST_PROPS_FOURCC_INT GST_PROPS_FOURCC_INT
GST_PROPS_BOOLEAN GST_PROPS_BOOLEAN
GST_PROPS_STRING
gst_props_register gst_props_register
gst_props_register_count gst_props_register_count
gst_props_new gst_props_new
@ -681,6 +687,7 @@ gst_props_set
gst_props_get_boolean gst_props_get_boolean
gst_props_get_fourcc_int gst_props_get_fourcc_int
gst_props_get_int gst_props_get_int
gst_props_get_string
gst_props_save_thyself gst_props_save_thyself
gst_props_load_thyself gst_props_load_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
@ -693,6 +700,7 @@ GST_PROPS_INT_ID
GST_PROPS_INT_RANGE_ID GST_PROPS_INT_RANGE_ID
GST_PROPS_FOURCC_ID GST_PROPS_FOURCC_ID
GST_PROPS_BOOL_ID GST_PROPS_BOOL_ID
GST_PROPS_STRING_ID
GST_PROPS_LAST_ID GST_PROPS_LAST_ID
</SECTION> </SECTION>
@ -926,6 +934,20 @@ GST_IS_TYPEFIND
GST_IS_TYPEFIND_CLASS GST_IS_TYPEFIND_CLASS
</SECTION> </SECTION>
<SECTION>
<FILE>gstmultidisksrc</FILE>
<TITLE>GstMultiDiskSrc</TITLE>
GstMultiDiskSrcFlags
<SUBSECTION Standard>
GstMultiDiskSrc
GST_MULTIDISKSRC
GST_IS_MULTIDISKSRC
GST_TYPE_MULTIDISKSRC
gst_multidisksrc_get_type
GST_MULTIDISKSRC_CLASS
GST_IS_MULTIDISKSRC_CLASS
</SECTION>
<SECTION> <SECTION>
<INCLUDE>gst/meta/spectrum.h</INCLUDE> <INCLUDE>gst/meta/spectrum.h</INCLUDE>
<FILE>spectrum</FILE> <FILE>spectrum</FILE>

View File

@ -15,6 +15,30 @@ a mime-type and a set of properties.
</para> </para>
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
<para>
Lock the caps structure
</para>
@caps: The caps structure to lock
<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
<para>
Try to lock the caps structure
</para>
@caps: The caps structure to try to lock
<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
<para>
Unlock the caps structure
</para>
@caps: The caps structure to unlock
<!-- ##### STRUCT GstCaps ##### --> <!-- ##### STRUCT GstCaps ##### -->
<para> <para>
@ -22,10 +46,10 @@ a mime-type and a set of properties.
@name: the name of the capability, for the application @name: the name of the capability, for the application
@id: the typeid of the capability @id: the typeid of the capability
@refcount: @refcount: a refcounter for this caps structure
@lock: @lock: the lock for this caps structure
@properties: the properties of the capability @properties: the properties of the capability
@next: @next: a pointer to the next caps.
<!-- ##### TYPEDEF GstCapsFactory ##### --> <!-- ##### TYPEDEF GstCapsFactory ##### -->
<para> <para>
@ -233,9 +257,6 @@ a mime-type and a set of properties.
@fromcaps: @fromcaps:
@tocaps: @tocaps:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@caps1:
@caps2:
<!-- ##### MACRO gst_caps_set ##### --> <!-- ##### MACRO gst_caps_set ##### -->

View File

@ -88,6 +88,14 @@ Create a boolean property.
@a: the boolean property @a: the boolean property
<!-- ##### MACRO GST_PROPS_STRING ##### -->
<para>
</para>
@a:
<!-- ##### FUNCTION gst_props_register ##### --> <!-- ##### FUNCTION gst_props_register ##### -->
<para> <para>
@ -226,6 +234,16 @@ Create a boolean property.
@Returns: @Returns:
<!-- ##### FUNCTION gst_props_get_string ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_save_thyself ##### --> <!-- ##### FUNCTION gst_props_save_thyself ##### -->
<para> <para>

View File

@ -67,14 +67,6 @@ Query the element for the current mime type
</para> </para>
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### --> <!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para> <para>
@ -83,7 +75,7 @@ Query the element for the current mime type
@pad: @pad:
@parent: @parent:
<!-- ##### FUNCTION gst_identity_chain ##### --> <!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para> <para>
</para> </para>
@ -91,7 +83,7 @@ Query the element for the current mime type
@pad: @pad:
@buf: @buf:
<!-- ##### FUNCTION gst_audiosink_chain ##### --> <!-- ##### FUNCTION gst_identity_chain ##### -->
<para> <para>
</para> </para>
@ -106,6 +98,14 @@ Query the element for the current mime type
@Returns: @Returns:
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### MACRO GST_PIPELINE_CLASS ##### --> <!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
<para> <para>
@ -349,16 +349,16 @@ subclass use this to start their flag enumeration
@audiosink: @audiosink:
@channels: @channels:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstSinkClass ##### --> <!-- ##### STRUCT GstSinkClass ##### -->
<para> <para>
</para> </para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstFilterClass ##### --> <!-- ##### STRUCT GstFilterClass ##### -->
<para> <para>
@ -602,13 +602,13 @@ Specify the current offset in the file.
</para> </para>
<!-- ##### ARG GstAudioSink:format ##### --> <!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para> <para>
</para> </para>
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### --> <!-- ##### ARG GstAudioSink:format ##### -->
<para> <para>
</para> </para>
@ -642,17 +642,24 @@ Specify the current offset in the file.
@name: @name:
@Returns: @Returns:
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### --> <!-- ##### STRUCT GstQueueClass ##### -->
<para> <para>
</para> </para>
<!-- ##### STRUCT GstConnection ##### --> <!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para> <para>
</para> </para>
@src:
<!-- ##### FUNCTION gst_type_add_sink ##### --> <!-- ##### FUNCTION gst_type_add_sink ##### -->
<para> <para>
@ -662,13 +669,6 @@ Specify the current offset in the file.
@id: @id:
@sink: @sink:
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### --> <!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
<para> <para>
@ -1066,13 +1066,6 @@ GstFilter
@obj: @obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### --> <!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para> <para>
@ -1080,6 +1073,13 @@ GstFilter
@obj: @obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_pad_get_type_id ##### --> <!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para> <para>
@ -1164,13 +1164,6 @@ GstColorSpace
@obj: @obj:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### --> <!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para> <para>
@ -1178,6 +1171,13 @@ GstColorSpace
@Returns: @Returns:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_SRC_CLASS ##### --> <!-- ##### MACRO GST_SRC_CLASS ##### -->
<para> <para>
@ -1207,6 +1207,12 @@ GstColorSpace
@pad: @pad:
@Returns: @Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_esdsink_new ##### --> <!-- ##### FUNCTION gst_esdsink_new ##### -->
<para> <para>
@ -1215,12 +1221,6 @@ GstColorSpace
@name: @name:
@Returns: @Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_request_pad ##### --> <!-- ##### FUNCTION gst_element_request_pad ##### -->
<para> <para>
@ -1357,16 +1357,16 @@ This macro sets the given flags.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### --> <!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para> <para>
A flag indicating that MMX instructions are supported. A flag indicating that MMX instructions are supported.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_object_get_type ##### --> <!-- ##### FUNCTION gst_object_get_type ##### -->
<para> <para>
@ -1650,13 +1650,6 @@ or a video card.
</para> </para>
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_BIN_CLASS ##### --> <!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<para> <para>
@ -1664,6 +1657,13 @@ or a video card.
@obj: @obj:
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### --> <!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
<para> <para>
@ -1684,6 +1684,12 @@ Query whether this object has multiple input pads.
@obj: Element to query for multiple input pads. @obj: Element to query for multiple input pads.
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_NOPREFIX ##### --> <!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para> <para>
@ -1692,12 +1698,6 @@ Query whether this object has multiple input pads.
@format: @format:
@args...: @args...:
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### --> <!-- ##### ARG GstAudioSink:frequency ##### -->
<para> <para>
@ -2052,6 +2052,13 @@ The start point of a filter graph
@audiosink: @audiosink:
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_UNSET ##### --> <!-- ##### MACRO GST_STATE_UNSET ##### -->
<para> <para>
This macro unsets the given state on the element. This macro unsets the given state on the element.
@ -2060,13 +2067,6 @@ This macro unsets the given state on the element.
@obj: Element to unset state of. @obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32. @flag: State to unset, can be any number of bits in guint32.
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_QUEUE_CLASS ##### --> <!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para> <para>
@ -2132,13 +2132,6 @@ The number of bytes per read.
@obj: @obj:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO ERROR_OBJECT ##### --> <!-- ##### MACRO ERROR_OBJECT ##### -->
<para> <para>
@ -2149,6 +2142,13 @@ The number of bytes per read.
@format: @format:
@args...: @args...:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_IDENTITY ##### --> <!-- ##### MACRO GST_IS_IDENTITY ##### -->
<para> <para>
@ -2253,6 +2253,13 @@ This macro sets the given state on the element.
@obj: @obj:
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_src_push_region ##### --> <!-- ##### FUNCTION gst_src_push_region ##### -->
<para> <para>
@ -2262,13 +2269,6 @@ This macro sets the given state on the element.
@offset: @offset:
@size: @size:
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### STRUCT GstPipelineClass ##### --> <!-- ##### STRUCT GstPipelineClass ##### -->
<para> <para>
@ -2353,13 +2353,13 @@ A flag indicating that SSE instructions are supported.
@obj: @obj:
<!-- ##### STRUCT GstDiskSrcClass ##### --> <!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para> <para>
</para> </para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### --> <!-- ##### STRUCT GstDiskSrcClass ##### -->
<para> <para>
</para> </para>
@ -2502,13 +2502,6 @@ the offset.
</para> </para>
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_sinesrc_new ##### --> <!-- ##### FUNCTION gst_sinesrc_new ##### -->
<para> <para>
@ -2517,6 +2510,13 @@ the offset.
@name: @name:
@Returns: @Returns:
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### ARG GstAudioSrc:curoffset ##### --> <!-- ##### ARG GstAudioSrc:curoffset ##### -->
<para> <para>
Get the current number of bytes read. Get the current number of bytes read.
@ -2565,13 +2565,6 @@ plugin
@klass: @klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### --> <!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para> <para>
@ -2579,6 +2572,13 @@ plugin
@klass: @klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### ARG GstPad:active ##### --> <!-- ##### ARG GstPad:active ##### -->
<para> <para>
Indicates this pad is active Indicates this pad is active