summaryrefslogtreecommitdiff
path: root/docs/gst/tmpl
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2005-09-02 16:17:23 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2005-09-02 16:17:23 +0000
commitc253951dcd371ef44f2bfef416789d053b04948f (patch)
treeefd7bb5d1f9b416afd6a95a25aeca1ccbd88bb96 /docs/gst/tmpl
parente040bb2dbe8373c723d2e973b311fd15dc72a76e (diff)
more docs inlined
Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/tmpl/.cvsignore: * docs/gst/tmpl/gstghostpad.sgml: * docs/gst/tmpl/gstiterator.sgml: * docs/gst/tmpl/gstmacros.sgml: * docs/gst/tmpl/gstrealpad.sgml: * docs/gst/tmpl/gstregistry.sgml: * docs/gst/tmpl/gstregistrypool.sgml: * docs/gst/tmpl/gststructure.sgml: * docs/gst/tmpl/gstsystemclock.sgml: * docs/gst/tmpl/gsttrace.sgml: * gst/gstghostpad.c: * gst/gstmacros.h: * gst/gstmemchunk.c: * gst/gstmemchunk.h: * gst/gstqueue.c: * gst/gstregistry.c: * gst/gstregistrypool.c: * gst/gststructure.c: * gst/gstsystemclock.c: more docs inlined
Diffstat (limited to 'docs/gst/tmpl')
-rw-r--r--docs/gst/tmpl/.gitignore9
-rw-r--r--docs/gst/tmpl/gstghostpad.sgml66
-rw-r--r--docs/gst/tmpl/gstiterator.sgml250
-rw-r--r--docs/gst/tmpl/gstmacros.sgml19
-rw-r--r--docs/gst/tmpl/gstrealpad.sgml16
-rw-r--r--docs/gst/tmpl/gstregistry.sgml20
-rw-r--r--docs/gst/tmpl/gstregistrypool.sgml127
-rw-r--r--docs/gst/tmpl/gststructure.sgml446
-rw-r--r--docs/gst/tmpl/gstsystemclock.sgml35
-rw-r--r--docs/gst/tmpl/gsttrace.sgml2
10 files changed, 10 insertions, 980 deletions
diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore
index 89d86a088..c6a2474a5 100644
--- a/docs/gst/tmpl/.gitignore
+++ b/docs/gst/tmpl/.gitignore
@@ -23,12 +23,21 @@ gstfilesrc.sgml
gstfilesink.sgml
gstfilter.sgml
gstformat.sgml
+gstghostpad.sgml
+gstiterator.sgml
+gstmacros.sgml
+gstmemchunck.sgml
gstmessage.sgml
gstminiobject.sgml
gstprobe.sgml
gstpushsrc.sgml
+gstqueue.sgml
gstquery.sgml
gstreamer-unused.sgml
+gstregistry.sgml
+gstregistrypool.sgml
+gststructure.sgml
+gstsystemclock.sgml
gsttask.sgml
gsturihandler.sgml
gsturitype.sgml
diff --git a/docs/gst/tmpl/gstghostpad.sgml b/docs/gst/tmpl/gstghostpad.sgml
deleted file mode 100644
index 0d8f2bf64..000000000
--- a/docs/gst/tmpl/gstghostpad.sgml
+++ /dev/null
@@ -1,66 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstGhostPad
-
-<!-- ##### SECTION Short_Description ##### -->
-Pseudo link pads
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstGhostPad ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
-<para>
-
-</para>
-
-@name:
-@target:
-@Returns:
-<!-- # Unused Parameters # -->
-@pad:
-
-
-<!-- ##### FUNCTION gst_ghost_pad_set_target ##### -->
-<para>
-
-</para>
-
-@gpad:
-@newtarget:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_ghost_pad_get_target ##### -->
-<para>
-
-</para>
-
-@gpad:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_ghost_pad_new_notarget ##### -->
-<para>
-
-</para>
-
-@name:
-@dir:
-@Returns:
-
-
diff --git a/docs/gst/tmpl/gstiterator.sgml b/docs/gst/tmpl/gstiterator.sgml
deleted file mode 100644
index b8f532ac5..000000000
--- a/docs/gst/tmpl/gstiterator.sgml
+++ /dev/null
@@ -1,250 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstIterator
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstIterator ##### -->
-<para>
-
-</para>
-
-@next:
-@item:
-@resync:
-@free:
-@pushed:
-@lock:
-@cookie:
-@master_cookie:
-
-<!-- ##### ENUM GstIteratorItem ##### -->
-<para>
-
-</para>
-
-@GST_ITERATOR_ITEM_SKIP:
-@GST_ITERATOR_ITEM_PASS:
-@GST_ITERATOR_ITEM_END:
-
-<!-- ##### ENUM GstIteratorResult ##### -->
-<para>
-
-</para>
-
-@GST_ITERATOR_DONE:
-@GST_ITERATOR_OK:
-@GST_ITERATOR_RESYNC:
-@GST_ITERATOR_ERROR:
-
-<!-- ##### USER_FUNCTION GstIteratorDisposeFunction ##### -->
-<para>
-
-</para>
-
-@owner:
-
-
-<!-- ##### USER_FUNCTION GstIteratorNextFunction ##### -->
-<para>
-
-</para>
-
-@it:
-@result:
-@Returns:
-
-
-<!-- ##### USER_FUNCTION GstIteratorItemFunction ##### -->
-<para>
-
-</para>
-
-@it:
-@item:
-@Returns:
-
-
-<!-- ##### USER_FUNCTION GstIteratorResyncFunction ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### USER_FUNCTION GstIteratorFreeFunction ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### USER_FUNCTION GstIteratorFoldFunction ##### -->
-<para>
-
-</para>
-
-@item:
-@ret:
-@user_data:
-@Returns:
-
-
-<!-- ##### MACRO GST_ITERATOR ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### MACRO GST_ITERATOR_LOCK ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### MACRO GST_ITERATOR_COOKIE ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### MACRO GST_ITERATOR_ORIG_COOKIE ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### FUNCTION gst_iterator_new ##### -->
-<para>
-
-</para>
-
-@size:
-@lock:
-@master_cookie:
-@next:
-@item:
-@resync:
-@free:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_iterator_new_list ##### -->
-<para>
-
-</para>
-
-@lock:
-@master_cookie:
-@list:
-@owner:
-@item:
-@free:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_iterator_next ##### -->
-<para>
-
-</para>
-
-@it:
-@elem:
-@Returns:
-<!-- # Unused Parameters # -->
-@result:
-
-
-<!-- ##### FUNCTION gst_iterator_resync ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### FUNCTION gst_iterator_free ##### -->
-<para>
-
-</para>
-
-@it:
-
-
-<!-- ##### FUNCTION gst_iterator_push ##### -->
-<para>
-
-</para>
-
-@it:
-@other:
-
-
-<!-- ##### FUNCTION gst_iterator_filter ##### -->
-<para>
-
-</para>
-
-@it:
-@func:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_iterator_fold ##### -->
-<para>
-
-</para>
-
-@iter:
-@func:
-@ret:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_iterator_foreach ##### -->
-<para>
-
-</para>
-
-@iter:
-@func:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_iterator_find_custom ##### -->
-<para>
-
-</para>
-
-@it:
-@func:
-@user_data:
-@Returns:
-
-
diff --git a/docs/gst/tmpl/gstmacros.sgml b/docs/gst/tmpl/gstmacros.sgml
deleted file mode 100644
index 8149bca8d..000000000
--- a/docs/gst/tmpl/gstmacros.sgml
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstMacros
-
-<!-- ##### SECTION Short_Description ##### -->
-various portabillity helper macros
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
diff --git a/docs/gst/tmpl/gstrealpad.sgml b/docs/gst/tmpl/gstrealpad.sgml
deleted file mode 100644
index 94cf055c3..000000000
--- a/docs/gst/tmpl/gstrealpad.sgml
+++ /dev/null
@@ -1,16 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstRealPad
-
-<!-- ##### SECTION Short_Description ##### -->
-Real link pads
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml
deleted file mode 100644
index be6b3810d..000000000
--- a/docs/gst/tmpl/gstregistry.sgml
+++ /dev/null
@@ -1,20 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstRegistry
-
-<!-- ##### SECTION Short_Description ##### -->
-Abstract base class for management of #GstPlugin objects.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-One registry holds the metadata of a set of plugins.
-All registries build the #GstRegistryPool.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GstPlugin, #GstPluginFeature
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
diff --git a/docs/gst/tmpl/gstregistrypool.sgml b/docs/gst/tmpl/gstregistrypool.sgml
deleted file mode 100644
index 99de4f98c..000000000
--- a/docs/gst/tmpl/gstregistrypool.sgml
+++ /dev/null
@@ -1,127 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstRegistryPool
-
-<!-- ##### SECTION Short_Description ##### -->
-Management of a group of #GstRegistry objects
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The registry pool manages the available registries and plugins in
-the system.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-GstRegistry
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### FUNCTION gst_registry_pool_list ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_add ##### -->
-<para>
-
-</para>
-
-@registry:
-@priority:
-
-
-<!-- ##### FUNCTION gst_registry_pool_remove ##### -->
-<para>
-
-</para>
-
-@registry:
-
-
-<!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
-<para>
-
-</para>
-
-@plugin:
-
-
-<!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_registry_pool_plugin_filter ##### -->
-<para>
-
-</para>
-
-@filter:
-@first:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_feature_filter ##### -->
-<para>
-
-</para>
-
-@filter:
-@first:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
-<para>
-
-</para>
-
-@type:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
-<para>
-
-</para>
-
-@name:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
-<para>
-
-</para>
-
-@name:
-@type:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
-<para>
-
-</para>
-
-@flags:
-@Returns:
-
-
diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml
deleted file mode 100644
index 77f3a1752..000000000
--- a/docs/gst/tmpl/gststructure.sgml
+++ /dev/null
@@ -1,446 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstStructure
-
-<!-- ##### SECTION Short_Description ##### -->
-Generic structure containing fields of names and values
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstStructure ##### -->
-<para>
-
-</para>
-
-@type:
-
-<!-- ##### USER_FUNCTION GstStructureForeachFunc ##### -->
-<para>
-
-</para>
-
-@field_id:
-@value:
-@user_data:
-@Returns:
-
-
-<!-- ##### USER_FUNCTION GstStructureMapFunc ##### -->
-<para>
-
-</para>
-
-@field_id:
-@value:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_empty_new ##### -->
-<para>
-
-</para>
-
-@name:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_id_empty_new ##### -->
-<para>
-
-</para>
-
-@quark:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_new ##### -->
-<para>
-
-</para>
-
-@name:
-@firstfield:
-@Varargs:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_new_valist ##### -->
-<para>
-
-</para>
-
-@name:
-@firstfield:
-@varargs:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_copy ##### -->
-<para>
-
-</para>
-
-@structure:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_free ##### -->
-<para>
-
-</para>
-
-@structure:
-
-
-<!-- ##### FUNCTION gst_structure_get_name ##### -->
-<para>
-
-</para>
-
-@structure:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_has_name ##### -->
-<para>
-
-</para>
-
-@structure:
-@name:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_set_name ##### -->
-<para>
-
-</para>
-
-@structure:
-@name:
-
-
-<!-- ##### FUNCTION gst_structure_get_name_id ##### -->
-<para>
-
-</para>
-
-@structure:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_id_get_value ##### -->
-<para>
-
-</para>
-
-@structure:
-@field:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_id_set_value ##### -->
-<para>
-
-</para>
-
-@structure:
-@field:
-@value:
-
-
-<!-- ##### FUNCTION gst_structure_get_value ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_set_value ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@value:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_set ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Varargs:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_set_valist ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@varargs:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_remove_field ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_remove_fields ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Varargs:
-<!-- # Unused Parameters # -->
-@fieldnamename:
-
-
-<!-- ##### FUNCTION gst_structure_remove_fields_valist ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@varargs:
-<!-- # Unused Parameters # -->
-@fieldnamename:
-
-
-<!-- ##### FUNCTION gst_structure_remove_all_fields ##### -->
-<para>
-
-</para>
-
-@structure:
-
-
-<!-- ##### FUNCTION gst_structure_get_field_type ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_foreach ##### -->
-<para>
-
-</para>
-
-@structure:
-@func:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_n_fields ##### -->
-<para>
-
-</para>
-
-@structure:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_has_field ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_has_field_typed ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@type:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_get_boolean ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@value:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_get_int ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@value:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_get_fourcc ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@value:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_get_double ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@value:
-@Returns:
-<!-- # Unused Parameters # -->
-@fieldnamename:
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_get_string ##### -->
-<para>
-
-</para>
-
-@structure:
-@fieldname:
-@Returns:
-<!-- # Unused Parameters # -->
-@field:
-
-
-<!-- ##### FUNCTION gst_structure_map_in_place ##### -->
-<para>
-
-</para>
-
-@structure:
-@func:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_nth_field_name ##### -->
-<para>
-
-</para>
-
-@structure:
-@index:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_set_parent_refcount ##### -->
-<para>
-
-</para>
-
-@structure:
-@refcount:
-
-
-<!-- ##### FUNCTION gst_structure_to_string ##### -->
-<para>
-
-</para>
-
-@structure:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_structure_from_string ##### -->
-<para>
-
-</para>
-
-@string:
-@end:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
-<para>
-
-</para>
-
-@structure:
-@field_name:
-@target:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
-<para>
-
-</para>
-
-@structure:
-@field_name:
-@target:
-@Returns:
-
-
diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml
deleted file mode 100644
index 71c56fd94..000000000
--- a/docs/gst/tmpl/gstsystemclock.sgml
+++ /dev/null
@@ -1,35 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstSystemClock
-
-<!-- ##### SECTION Short_Description ##### -->
-Default clock that uses the current system time
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The System clock is an implementation of GstClock using the
-system time.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GstClock
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstSystemClock ##### -->
-<para>
-
-</para>
-
-@clock:
-
-<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml
index 168b2aa98..0f69f428c 100644
--- a/docs/gst/tmpl/gsttrace.sgml
+++ b/docs/gst/tmpl/gsttrace.sgml
@@ -224,7 +224,7 @@ Use the tracer to trace a new memory allocation
Trace a memory free operation
</para>
-@trace: The traver to use
+@trace: The tracer to use
@mem: The memory that is freed