From 426ac6ae66c9ad1afdbe4572a4c9f9fe2ec14dfe Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Tue, 27 Mar 2001 17:34:39 +0000 Subject: [PATCH] More docs updates Original commit message from CVS: More docs updates --- docs/gst/gstreamer-sections.txt | 22 ++++ docs/gst/tmpl/gstcaps.sgml | 33 ++++- docs/gst/tmpl/gstprops.sgml | 18 +++ docs/gst/tmpl/gstreamer-unused.sgml | 196 ++++++++++++++-------------- 4 files changed, 165 insertions(+), 104 deletions(-) diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 7904d54ed0..3c0cde7e04 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -619,6 +619,9 @@ gst_typefactory_save_thyself
gstcaps GstCaps +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 +GST_CAPS
@@ -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 @@ -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
@@ -926,6 +934,20 @@ GST_IS_TYPEFIND GST_IS_TYPEFIND_CLASS +
+gstmultidisksrc +GstMultiDiskSrc +GstMultiDiskSrcFlags + +GstMultiDiskSrc +GST_MULTIDISKSRC +GST_IS_MULTIDISKSRC +GST_TYPE_MULTIDISKSRC +gst_multidisksrc_get_type +GST_MULTIDISKSRC_CLASS +GST_IS_MULTIDISKSRC_CLASS +
+
gst/meta/spectrum.h spectrum diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 014c2854ec..621f2764b8 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -15,6 +15,30 @@ a mime-type and a set of properties. + + +Lock the caps structure + + +@caps: The caps structure to lock + + + + +Try to lock the caps structure + + +@caps: The caps structure to try to lock + + + + +Unlock the caps structure + + +@caps: The caps structure to unlock + + @@ -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. @@ -233,9 +257,6 @@ a mime-type and a set of properties. @fromcaps: @tocaps: @Returns: - -@caps1: -@caps2: diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index eb27fb0b86..d0bf0f29f7 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -88,6 +88,14 @@ Create a boolean property. @a: the boolean property + + + + + +@a: + + @@ -226,6 +234,16 @@ Create a boolean property. @Returns: + + + + + +@props: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 2e111acc06..eccefac44b 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -67,14 +67,6 @@ Query the element for the current mime type - - - - - -@pad: -@buf: - @@ -83,7 +75,7 @@ Query the element for the current mime type @pad: @parent: - + @@ -91,7 +83,7 @@ Query the element for the current mime type @pad: @buf: - + @@ -106,6 +98,14 @@ Query the element for the current mime type @Returns: + + + + + +@pad: +@buf: + @@ -349,16 +349,16 @@ subclass use this to start their flag enumeration @audiosink: @channels: + +Generic connection between elements. + + - -Generic connection between elements. - - @@ -602,13 +602,13 @@ Specify the current offset in the file. - + - + @@ -642,17 +642,24 @@ Specify the current offset in the file. @name: @Returns: + + + + + + - + +@src: @@ -662,13 +669,6 @@ Specify the current offset in the file. @id: @sink: - - - - - -@src: - @@ -1066,13 +1066,6 @@ GstFilter @obj: - - - - - -@Returns: - @@ -1080,6 +1073,13 @@ GstFilter @obj: + + + + + +@Returns: + @@ -1164,13 +1164,6 @@ GstColorSpace @obj: - - - - - -@klass: - @@ -1178,6 +1171,13 @@ GstColorSpace @Returns: + + + + + +@klass: + @@ -1207,6 +1207,12 @@ GstColorSpace @pad: @Returns: + + + + + + @@ -1215,12 +1221,6 @@ GstColorSpace @name: @Returns: - - - - - - @@ -1357,16 +1357,16 @@ This macro sets the given flags. + +GstSink + + A flag indicating that MMX instructions are supported. - -GstSink - - @@ -1650,13 +1650,6 @@ or a video card. - - - - - -@Returns: - @@ -1664,6 +1657,13 @@ or a video card. @obj: + + + + + +@Returns: + @@ -1684,6 +1684,12 @@ Query whether this object has multiple input pads. @obj: Element to query for multiple input pads. + + + + + + @@ -1692,12 +1698,6 @@ Query whether this object has multiple input pads. @format: @args...: - - - - - - @@ -2052,6 +2052,13 @@ The start point of a filter graph @audiosink: + + + + + +@obj: + 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. @flag: State to unset, can be any number of bits in guint32. - - - - - -@obj: - @@ -2132,13 +2132,6 @@ The number of bytes per read. @obj: - - - - - -@Returns: - @@ -2149,6 +2142,13 @@ The number of bytes per read. @format: @args...: + + + + + +@Returns: + @@ -2253,6 +2253,13 @@ This macro sets the given state on the element. @obj: + + + + + +@Returns: + @@ -2262,13 +2269,6 @@ This macro sets the given state on the element. @offset: @size: - - - - - -@Returns: - @@ -2353,13 +2353,13 @@ A flag indicating that SSE instructions are supported. @obj: - + - + @@ -2502,13 +2502,6 @@ the offset. - - - - - -@obj: - @@ -2517,6 +2510,13 @@ the offset. @name: @Returns: + + + + + +@obj: + Get the current number of bytes read. @@ -2565,13 +2565,6 @@ plugin @klass: - - - - - -@obj: - @@ -2579,6 +2572,13 @@ plugin @klass: + + + + + +@obj: + Indicates this pad is active