More docs updates
authorWim Taymans <wim.taymans@gmail.com>
Tue, 27 Mar 2001 17:34:39 +0000 (17:34 +0000)
committerWim Taymans <wim.taymans@gmail.com>
Tue, 27 Mar 2001 17:34:39 +0000 (17:34 +0000)
Original commit message from CVS:
More docs updates

docs/gst/gstreamer-sections.txt
docs/gst/tmpl/gstcaps.sgml
docs/gst/tmpl/gstprops.sgml
docs/gst/tmpl/gstreamer-unused.sgml

index 7904d54..3c0cde7 100644 (file)
@@ -619,6 +619,9 @@ gst_typefactory_save_thyself
 <SECTION>
 <FILE>gstcaps</FILE>
 <TITLE>GstCaps</TITLE>
+GST_CAPS_LOCK
+GST_CAPS_TRYLOCK
+GST_CAPS_UNLOCK
 GstCaps
 GstCapsFactory
 GstCapsFactoryEntry
@@ -649,10 +652,12 @@ gst_caps_get_boolean
 gst_caps_get_by_name
 gst_caps_get_fourcc_int
 gst_caps_get_int
+gst_caps_get_string
 
 gst_caps_save_thyself
 gst_caps_load_thyself
 <SUBSECTION Standard>
+GST_CAPS
 </SECTION>
 
 <SECTION>
@@ -667,6 +672,7 @@ GST_PROPS_INT_RANGE
 GST_PROPS_FOURCC
 GST_PROPS_FOURCC_INT
 GST_PROPS_BOOLEAN
+GST_PROPS_STRING
 gst_props_register
 gst_props_register_count
 gst_props_new
@@ -681,6 +687,7 @@ gst_props_set
 gst_props_get_boolean
 gst_props_get_fourcc_int
 gst_props_get_int
+gst_props_get_string
 gst_props_save_thyself
 gst_props_load_thyself
 <SUBSECTION Standard>
@@ -693,6 +700,7 @@ GST_PROPS_INT_ID
 GST_PROPS_INT_RANGE_ID
 GST_PROPS_FOURCC_ID
 GST_PROPS_BOOL_ID
+GST_PROPS_STRING_ID
 GST_PROPS_LAST_ID
 </SECTION>
 
@@ -927,6 +935,20 @@ GST_IS_TYPEFIND_CLASS
 </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>
 <INCLUDE>gst/meta/spectrum.h</INCLUDE>
 <FILE>spectrum</FILE>
 MetaAudioSpectrum
index 014c285..621f276 100644 (file)
@@ -15,6 +15,30 @@ a mime-type and a set of properties.
 
 </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 ##### -->
 <para>
 
@@ -22,10 +46,10 @@ a mime-type and a set of properties.
 
 @name: the name of the capability, for the application
 @id: the typeid of the capability
-@refcount: 
-@lock: 
+@refcount: a refcounter for this caps structure
+@lock: the lock for this caps structure
 @properties: the properties of the capability
-@next: 
+@next: a pointer to the next caps.
 
 <!-- ##### TYPEDEF GstCapsFactory ##### -->
 <para>
@@ -233,9 +257,6 @@ a mime-type and a set of properties.
 @fromcaps: 
 @tocaps: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@caps1: 
-@caps2: 
 
 
 <!-- ##### MACRO gst_caps_set ##### -->
index eb27fb0..d0bf0f2 100644 (file)
@@ -88,6 +88,14 @@ Create a boolean property.
 @a: the boolean property
 
 
+<!-- ##### MACRO GST_PROPS_STRING ##### -->
+<para>
+
+</para>
+
+@a: 
+
+
 <!-- ##### FUNCTION gst_props_register ##### -->
 <para>
 
@@ -226,6 +234,16 @@ Create a boolean property.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_props_get_string ##### -->
+<para>
+
+</para>
+
+@props: 
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_props_save_thyself ##### -->
 <para>
 
index 2e111ac..eccefac 100644 (file)
@@ -67,21 +67,21 @@ Query the element for the current mime type
 </para>
 
 
-<!-- ##### FUNCTION gst_fdsink_chain ##### -->
+<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
 <para>
 
 </para>
 
 @pad: 
-@buf
+@parent
 
-<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
+<!-- ##### FUNCTION gst_fdsink_chain ##### -->
 <para>
 
 </para>
 
 @pad: 
-@parent
+@buf
 
 <!-- ##### FUNCTION gst_identity_chain ##### -->
 <para>
@@ -91,20 +91,20 @@ Query the element for the current mime type
 @pad: 
 @buf: 
 
-<!-- ##### FUNCTION gst_audiosink_chain ##### -->
+<!-- ##### FUNCTION gst_connection_get_type ##### -->
 <para>
 
 </para>
 
-@pad: 
-@buf: 
+@Returns: 
 
-<!-- ##### FUNCTION gst_connection_get_type ##### -->
+<!-- ##### FUNCTION gst_audiosink_chain ##### -->
 <para>
 
 </para>
 
-@Returns: 
+@pad: 
+@buf: 
 
 <!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
 <para>
@@ -349,16 +349,16 @@ subclass use this to start their flag enumeration
 @audiosink: 
 @channels: 
 
+<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
+Generic connection between elements.
+
+
 <!-- ##### STRUCT GstSinkClass ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
-Generic connection between elements.
-
-
 <!-- ##### STRUCT GstFilterClass ##### -->
 <para>
 
@@ -602,13 +602,13 @@ Specify the current offset in the file.
 </para>
 
 
-<!-- ##### ARG GstAudioSink:format ##### -->
+<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
+<!-- ##### ARG GstAudioSink:format ##### -->
 <para>
 
 </para>
@@ -642,32 +642,32 @@ Specify the current offset in the file.
 @name: 
 @Returns: 
 
-<!-- ##### STRUCT GstQueueClass ##### -->
+<!-- ##### STRUCT GstConnection ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### STRUCT GstConnection ##### -->
+<!-- ##### STRUCT GstQueueClass ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### FUNCTION gst_type_add_sink ##### -->
+<!-- ##### FUNCTION gst_fakesrc_push ##### -->
 <para>
 
 </para>
 
-@id: 
-@sink: 
+@src: 
 
-<!-- ##### FUNCTION gst_fakesrc_push ##### -->
+<!-- ##### FUNCTION gst_type_add_sink ##### -->
 <para>
 
 </para>
 
-@src: 
+@id: 
+@sink: 
 
 <!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
 <para>
@@ -1066,19 +1066,19 @@ GstFilter
 
 @obj: 
 
-<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
+<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
 <para>
 
 </para>
 
-@Returns
+@obj
 
-<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
+<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
 <para>
 
 </para>
 
-@obj
+@Returns
 
 <!-- ##### FUNCTION gst_pad_get_type_id ##### -->
 <para>
@@ -1164,19 +1164,19 @@ GstColorSpace
 
 @obj: 
 
-<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
+<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
 <para>
 
 </para>
 
-@klass: 
+@Returns: 
 
-<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
+<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
 <para>
 
 </para>
 
-@Returns: 
+@klass: 
 
 <!-- ##### MACRO GST_SRC_CLASS ##### -->
 <para>
@@ -1207,19 +1207,19 @@ GstColorSpace
 @pad: 
 @Returns: 
 
-<!-- ##### FUNCTION gst_esdsink_new ##### -->
+<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
 <para>
 
 </para>
 
-@name: 
-@Returns: 
 
-<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
+<!-- ##### FUNCTION gst_esdsink_new ##### -->
 <para>
 
 </para>
 
+@name: 
+@Returns: 
 
 <!-- ##### FUNCTION gst_element_request_pad ##### -->
 <para>
@@ -1357,16 +1357,16 @@ This macro sets the given flags.
 </para>
 
 
+<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
+GstSink
+
+
 <!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
 <para>
 A flag indicating that MMX instructions are supported.
 </para>
 
 
-<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
-GstSink
-
-
 <!-- ##### FUNCTION gst_object_get_type ##### -->
 <para>
 
@@ -1650,19 +1650,19 @@ or a video card.
 </para>
 
 
-<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
+<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
 <para>
 
 </para>
 
-@Returns
+@obj
 
-<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
+<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
 <para>
 
 </para>
 
-@obj
+@Returns
 
 <!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
 <para>
@@ -1684,19 +1684,19 @@ Query whether this object has multiple input pads.
 
 @obj: Element to query for multiple input pads.
 
-<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
+<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
 <para>
 
 </para>
 
-@format: 
-@args...: 
 
-<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
+<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
 <para>
 
 </para>
 
+@format: 
+@args...: 
 
 <!-- ##### ARG GstAudioSink:frequency ##### -->
 <para>
@@ -2052,20 +2052,20 @@ The start point of a filter graph
 
 @audiosink: 
 
-<!-- ##### MACRO GST_STATE_UNSET ##### -->
+<!-- ##### MACRO GST_IS_FAKESINK ##### -->
 <para>
-This macro unsets the given state on the element.
+
 </para>
 
-@obj: Element to unset state of.
-@flag: State to unset, can be any number of bits in guint32.
+@obj: 
 
-<!-- ##### MACRO GST_IS_FAKESINK ##### -->
+<!-- ##### MACRO GST_STATE_UNSET ##### -->
 <para>
-
+This macro unsets the given state on the element.
 </para>
 
-@obj: 
+@obj: Element to unset state of.
+@flag: State to unset, can be any number of bits in guint32.
 
 <!-- ##### MACRO GST_QUEUE_CLASS ##### -->
 <para>
@@ -2132,13 +2132,6 @@ The number of bytes per read.
 
 @obj: 
 
-<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
 <!-- ##### MACRO ERROR_OBJECT ##### -->
 <para>
 
@@ -2149,6 +2142,13 @@ The number of bytes per read.
 @format: 
 @args...: 
 
+<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### MACRO GST_IS_IDENTITY ##### -->
 <para>
 
@@ -2253,21 +2253,21 @@ This macro sets the given state on the element.
 
 @obj: 
 
-<!-- ##### FUNCTION gst_src_push_region ##### -->
+<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
 <para>
 
 </para>
 
-@src: 
-@offset: 
-@size: 
+@Returns: 
 
-<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
+<!-- ##### FUNCTION gst_src_push_region ##### -->
 <para>
 
 </para>
 
-@Returns: 
+@src: 
+@offset: 
+@size: 
 
 <!-- ##### STRUCT GstPipelineClass ##### -->
 <para>
@@ -2353,13 +2353,13 @@ A flag indicating that SSE instructions are supported.
 
 @obj: 
 
-<!-- ##### STRUCT GstDiskSrcClass ##### -->
+<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
+<!-- ##### STRUCT GstDiskSrcClass ##### -->
 <para>
 
 </para>
@@ -2502,20 +2502,20 @@ the offset.
 </para>
 
 
-<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
+<!-- ##### FUNCTION gst_sinesrc_new ##### -->
 <para>
 
 </para>
 
-@obj: 
+@name: 
+@Returns: 
 
-<!-- ##### FUNCTION gst_sinesrc_new ##### -->
+<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
 <para>
 
 </para>
 
-@name: 
-@Returns: 
+@obj: 
 
 <!-- ##### ARG GstAudioSrc:curoffset ##### -->
 <para>
@@ -2565,19 +2565,19 @@ plugin
 
 @klass: 
 
-<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
+<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
 <para>
 
 </para>
 
-@obj
+@klass
 
-<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
+<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
 <para>
 
 </para>
 
-@klass
+@obj
 
 <!-- ##### ARG GstPad:active ##### -->
 <para>