put symbols in the sections.txt into the right sections (so that we dont get wrong...

Original commit message from CVS:
put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols)
added TITLE tags where they were missing
fixed section names so that gtk-doc introspection works
fixed typos in api docs and docbook docs
added some thoughts about new interfaces (to personal notes)

diff --git a/docs/README b/docs/README
index 3351b1d..8ba6d20 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -87,6 +87,14 @@ HOW THE BUILD SYSTEM IS SET UP
 * ps and pdf are built in the current dir, in one file
 
 
+DOCBOOK NOTES
+=============
+
+* spell checking with aspell
+  * aspell -b -c --mode=sgml --lang=en <file>.xml
+    unfortunately the curses-ui of aspell (0.50.5) has problems with the xml tags
+
+
 GTK-DOC NOTES
 =============
 
@@ -108,10 +116,21 @@ GTK-DOC NOTES
   - add both an entity and use the entity in gstreamer-docs.sgml
   - add a new section to gstreamer-sections.txt
   - add all documented symbols to gstreamer-sections.txt in the proper section
+    (default),<SUBSECTION Standard>,<SUBSECTION Private>
+  - document at least the Short_Description in tmpl/.sgml
+  - signals: document them properly in tmpl/.sgml (or better in the c-source)
 
-  - signals: document them properly in tmpl/.sgml
 * checklist:
   - make sure -sections.txt has a <TITLE> set for each <FILE>
+  - the title should be named like the type, when it gets registered
+    (otherwise gtkdoc introspection fails)
+  - for clarity name the file like the title, but all lowercase
+
+* what to do when trying to improve the docs
+  - compare the output of
+    grep "_get_type" gstreamer-sections.txt | sort
+    with the types in XXX.types to detect entries that
+    are maybe missing
 
 * what happens during a gtk-doc build ?
   - headers are scanned based on $(MODULE).types
@@ -120,12 +139,9 @@ GTK-DOC NOTES
     where the module name is  $(MODULE)
     $(MODULE)-sections.txt is created if it doesn't exist yet (it should),
     as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt
-    
     and .args, .hierarchy and .signals files are created
     gtkdoc-scan is called 
 
-  (FIXME: why is there gstreamer.types.in and gst-plugins.types.in ?)
-
 * Possible errors and how to fix them
   - Warning: multiple "IDs" for constraint linkend: gst-tag-register.
     - check if gst_tag_register is listed more than once in -sections.txt
@@ -156,3 +172,4 @@ RANDOM THINGS I'VE LEARNED
   xsltproc has a --path option (that xmlto doesn't use yet), but it
   resolves single files to $(specified_path)/$(srcdir)/$(file)
   For now, we need to hack around it by copying xml to the build dir.
+

diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index af052c9..d14e8a4 100644 (file)
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -17,8 +17,8 @@
 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
 <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
 <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
+<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
 <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
-<!ENTITY GstInterface SYSTEM "xml/gstinterface.xml">
 <!ENTITY GstLog SYSTEM "xml/gstlog.xml">
 <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
 <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
@@ -35,7 +35,7 @@
 <!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
 <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
 <!ENTITY GstTag SYSTEM "xml/gsttag.xml">
-<!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml">
+<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
 <!ENTITY GstThread SYSTEM "xml/gstthread.xml">
 <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
 <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
@@ -70,10 +70,12 @@
   <chapter id="gstreamer">
     <title>GStreamer Core Library</title>
 
-    <para>libgstreamer-0.8.so provides all the core GStreamer services,
-including initialization, plugin management and types, as 
-well as the object hierarchy that defines elements and bins, along
-with some more specialized elements.</para>
+    <para>
+      libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
+      including initialization, plugin management and types,
+      as well as the object hierarchy that defines elements and bins,
+      along with some more specialized elements.
+    </para>
 
     &Gst;
     &GstBin;
@@ -89,7 +91,7 @@ with some more specialized elements.</para>
     &GstFormat;
     &GstIndex;
     &GstInfo;
-    &GstInterface;
+    &GstImplementsInterface;
     &GstObject;
     &GstPad;
     &GstParse;
@@ -105,7 +107,7 @@ with some more specialized elements.</para>
     &GstStructure;
     &GstSystemClock;
     &GstTag;
-    &GstTagInterface;
+    &GstTagSetter;
     &GstThread;
     &GstTypeFind;
     &GstUri;
@@ -118,6 +120,7 @@ with some more specialized elements.</para>
   <chapter id="gstreamer-support">
     <title>GStreamer Core Support</title>
     <para>
+      Theses elements support the gstreamer core and applications using it.
     </para>
 
     &GstAtomic;
@@ -126,6 +129,7 @@ with some more specialized elements.</para>
   </chapter>
 
 <!--
+  FIXME: why is this commented out
   <chapter id="element-types">
     <title>GStreamer Standard Elements</title>
 

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 17888c8..cc13acf 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1,7 +1,8 @@
 <SECTION>
 <FILE>gstbin</FILE>
-GstBinFlags
 <TITLE>GstBin</TITLE>
+GstBin
+GstBinFlags
 gst_bin_new
 gst_bin_add
 gst_bin_add_many
@@ -19,17 +20,20 @@ gst_bin_auto_clock
 gst_bin_sync_children_state
 gst_bin_child_state_change
 <SUBSECTION Standard>
+GstBinClass
 GST_BIN
 GST_IS_BIN
 GST_TYPE_BIN
-gst_bin_get_type
 GST_BIN_CLASS
 GST_IS_BIN_CLASS
 GST_BIN_GET_CLASS
+<SUBSECTION Private>
+gst_bin_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstbuffer</FILE>
+<TITLE>GstBuffer</TITLE>
 GstBuffer
 GstBufferFreeDataFunc
 GST_BUFFER_TRACE_NAME
@@ -79,11 +83,13 @@ gst_buffer_default_copy
 GST_BUFFER
 GST_IS_BUFFER
 GST_TYPE_BUFFER
+<SUBSECTION Private>
 gst_buffer_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstcaps</FILE>
+<TITLE>GstCaps</TITLE>
 GST_CAPS_FLAGS_ANY
 GST_CAPS_ANY
 GST_CAPS_NONE
@@ -136,11 +142,13 @@ gst_caps_subtract
 GST_CAPS
 GST_IS_CAPS
 GST_TYPE_CAPS
+<SUBSECTION Private>
 gst_caps_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstclock</FILE>
+<TITLE>GstClock</TITLE>
 GstClock
 GstClockTime
 GstClockTimeDiff
@@ -168,7 +176,6 @@ GST_CLOCK_ENTRY_STATUS
 GstClockReturn
 GstClockFlags
 GST_CLOCK_FLAGS
-<TITLE>GstClock</TITLE>
 gst_clock_set_speed
 gst_clock_get_speed
 gst_clock_set_resolution
@@ -194,10 +201,11 @@ GstClockClass
 GST_CLOCK
 GST_IS_CLOCK
 GST_TYPE_CLOCK
-gst_clock_get_type
 GST_CLOCK_CLASS
 GST_IS_CLOCK_CLASS
 GST_CLOCK_GET_CLASS
+<SUBSECTION Private>
+gst_clock_get_type
 </SECTION>
 
 <SECTION>
@@ -227,6 +235,7 @@ GST_PAD_IS_CONNECTED
 
 <SECTION>
 <FILE>gstdata</FILE>
+<TITLE>GstData</TITLE>
 GST_DATA
 GST_DATA_TYPE
 GST_DATA_FLAGS
@@ -253,13 +262,14 @@ gst_data_unref
 <SUBSECTION Standard>
 GST_DATA_FLAG_SET
 GST_DATA_FLAG_IS_SET
+<SUBSECTION Private>
 gst_data_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstelement</FILE>
 GstElement
-GstElementClass
+GST_TYPE_ELEMENT
 GstElementDetails
 GST_ELEMENT_DETAILS
 GST_IS_ELEMENT_DETAILS
@@ -273,7 +283,6 @@ GST_STATE_PAUSED_TO_PLAYING
 GST_STATE_PLAYING_TO_PAUSED
 GST_STATE_PAUSED_TO_READY
 GST_STATE_READY_TO_NULL
-GST_ELEMENT_CLASS
 GST_ELEMENT_QUERY_TYPE_FUNCTION
 GST_ELEMENT_FORMATS_FUNCTION
 GST_ELEMENT_EVENT_MASK_FUNCTION
@@ -374,7 +383,6 @@ gst_element_get_factory
 gst_element_get_managing_bin
 gst_element_no_more_pads
 <TITLE>GstElementFactory</TITLE>
-gst_element_factory_get_type
 gst_element_register
 gst_element_factory_find
 gst_element_factory_get_element_type
@@ -391,23 +399,29 @@ gst_element_factory_make
 gst_element_factory_can_src_caps
 gst_element_factory_can_sink_caps
 GstElementFactory
-GstElementFactoryClass
 GST_TYPE_ELEMENT_FACTORY
-GST_ELEMENT_FACTORY
-GST_ELEMENT_FACTORY_CLASS
-GST_IS_ELEMENT_FACTORY
-GST_IS_ELEMENT_FACTORY_CLASS
 <SUBSECTION Standard>
+GstElementClass
 GST_ELEMENT
 GST_IS_ELEMENT
-GST_TYPE_ELEMENT
-gst_element_get_type
+GST_ELEMENT_CLASS
 GST_IS_ELEMENT_CLASS
 GST_ELEMENT_GET_CLASS
+GstElementFactoryClass
+GST_ELEMENT_FACTORY
+GST_IS_ELEMENT_FACTORY
+GST_ELEMENT_FACTORY_CLASS
+GST_IS_ELEMENT_FACTORY_CLASS
+<SUBSECTION Private>
+gst_element_get_type
+gst_element_factory_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstevent</FILE>
+<TITLE>GstEvent</TITLE>
+GST_TYPE_EVENT
+GstEvent
 GstEventType
 GST_EVENT_ANY
 GST_EVENT_TRACE_NAME
@@ -438,7 +452,6 @@ GST_EVENT_DISCONT_OFFSET_LEN
 GST_EVENT_SIZE_FORMAT
 GST_EVENT_SIZE_VALUE
 GST_EVENT_RATE_VALUE
-GstEvent
 gst_event_new
 gst_event_ref
 gst_event_ref_by_count
@@ -456,7 +469,7 @@ gst_event_new_flush
 <SUBSECTION Standard>
 GST_EVENT
 GST_IS_EVENT
-GST_TYPE_EVENT
+<SUBSECTION Private>
 gst_event_get_type
 </SECTION>
 
@@ -507,15 +520,8 @@ gst_index_entry_copy
 gst_index_entry_free
 gst_index_entry_assoc_map
 GST_TYPE_INDEX_FACTORY
-GST_INDEX_FACTORY
-GST_IS_INDEX_FACTORY
-GST_INDEX_FACTORY_CLASS
-GST_IS_INDEX_FACTORY_CLASS
-GST_INDEX_FACTORY_GET_CLASS
 <TITLE>GstIndexFactory</TITLE>
 GstIndexFactory
-GstIndexFactoryClass
-gst_index_factory_get_type
 gst_index_factory_new
 gst_index_factory_destroy
 gst_index_factory_find
@@ -526,14 +532,24 @@ GstIndexClass
 GST_INDEX
 GST_IS_INDEX
 GST_TYPE_INDEX
-gst_index_get_type
 GST_INDEX_CLASS
 GST_IS_INDEX_CLASS
 GST_INDEX_GET_CLASS
+GstIndexFactoryClass
+GST_INDEX_FACTORY
+GST_IS_INDEX_FACTORY
+GST_INDEX_FACTORY_CLASS
+GST_IS_INDEX_FACTORY_CLASS
+GST_INDEX_FACTORY_GET_CLASS
+<SUBSECTION Private>
+gst_index_get_type
+gst_index_factory_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gstinterface</FILE>
+<FILE>gstimplementsinterface</FILE>
+<TITLE>GstImplementsInterface</TITLE>
+GST_TYPE_IMPLEMENTS_INTERFACE
 GstImplementsInterface
 GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST
 GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE
@@ -541,21 +557,22 @@ gst_element_implements_interface
 gst_implements_interface_cast
 gst_implements_interface_check
 <SUBSECTION Standard>
+GstImplementsInterfaceClass
 GST_IMPLEMENTS_INTERFACE
-GST_IS_IMPLEMENTS_INTERFACE
-GST_TYPE_IMPLEMENTS_INTERFACE
-gst_implements_interface_get_type
 GST_IMPLEMENTS_INTERFACE_CLASS
+GST_IS_IMPLEMENTS_INTERFACE
 GST_IS_IMPLEMENTS_INTERFACE_CLASS
 GST_IMPLEMENTS_INTERFACE_GET_CLASS
+<SUBSECTION Private>
+gst_implements_interface_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstobject</FILE>
-GST_OBJECT_CLASS
-xmlNodePtr
-GstObjectFlags
 <TITLE>GstObject</TITLE>
+GstObject
+GST_TYPE_OBJECT
+GstObjectFlags
 GST_FLAGS
 GST_FLAG_IS_SET
 GST_FLAG_SET
@@ -585,36 +602,28 @@ gst_object_get_path_string
 gst_class_signal_connect
 gst_class_signal_emit_by_name
 <SUBSECTION Standard>
+GstObjectClass
 GST_OBJECT
 GST_IS_OBJECT
-GST_TYPE_OBJECT
-gst_object_get_type
+GST_OBJECT_CLASS
 GST_IS_OBJECT_CLASS
 GST_OBJECT_GET_CLASS
+<SUBSECTION Private>
+gst_object_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstpad</FILE>
 GstPad
-GstPadClass
 GstRealPad
 GstGhostPad
-GstRealPadClass
-GstGhostPadClass
-GST_IS_PAD_FAST
-GST_PAD_CLASS
+GstPadTemplate
+GST_TYPE_PAD
 GST_TYPE_REAL_PAD
-GST_IS_REAL_PAD
 GST_IS_REAL_PAD_FAST
-GST_IS_REAL_PAD_CLASS
-GST_REAL_PAD
-GST_REAL_PAD_CLASS
 GST_TYPE_GHOST_PAD
-GST_IS_GHOST_PAD
 GST_IS_GHOST_PAD_FAST
-GST_IS_GHOST_PAD_CLASS
-GST_GHOST_PAD
-GST_GHOST_PAD_CLASS
+GST_IS_PAD_FAST
 GstStaticPadTemplate
 GstPadLink
 GstPadLinkReturn
@@ -684,10 +693,6 @@ GST_PAD_CAN_PULL
 GST_PAD_IS_SRC
 GST_PAD_IS_SINK
 GST_TYPE_PAD_TEMPLATE
-GST_PAD_TEMPLATE
-GST_PAD_TEMPLATE_CLASS
-GST_IS_PAD_TEMPLATE
-GST_IS_PAD_TEMPLATE_CLASS
 GstPadPresence
 GST_PAD_TEMPLATE_NAME_TEMPLATE
 GST_PAD_TEMPLATE_DIRECTION
@@ -697,8 +702,6 @@ GstPadTemplateFlags
 GST_PAD_TEMPLATE_IS_FIXED
 <TITLE>GstPadTemplate</TITLE>
 GST_STATIC_PAD_TEMPLATE
-gst_real_pad_get_type
-gst_ghost_pad_get_type
 gst_pad_new
 gst_pad_new_from_template
 gst_pad_custom_new
@@ -788,18 +791,37 @@ gst_pad_add_probe
 gst_pad_remove_probe
 gst_pad_load_and_link
 gst_ghost_pad_new
-gst_pad_template_get_type
 gst_pad_template_new
 gst_static_pad_template_get
 gst_pad_template_get_caps
 gst_pad_template_get_caps_by_name
 gst_ghost_pad_save_thyself
 <SUBSECTION Standard>
+GstPadClass
 GST_PAD
 GST_IS_PAD
-GST_TYPE_PAD
-gst_pad_get_type
+GST_PAD_CLASS
 GST_IS_PAD_CLASS
+GstGhostPadClass
+GST_GHOST_PAD
+GST_IS_GHOST_PAD
+GST_GHOST_PAD_CLASS
+GST_IS_GHOST_PAD_CLASS
+GstRealPadClass
+GST_REAL_PAD
+GST_IS_REAL_PAD
+GST_REAL_PAD_CLASS
+GST_IS_REAL_PAD_CLASS
+GstPadTemplateClass
+GST_PAD_TEMPLATE
+GST_IS_PAD_TEMPLATE
+GST_PAD_TEMPLATE_CLASS
+GST_IS_PAD_TEMPLATE_CLASS
+<SUBSECTION Private>
+gst_pad_get_type
+gst_real_pad_get_type
+gst_ghost_pad_get_type
+gst_pad_template_get_type
 </SECTION>
 
 <SECTION>
@@ -812,10 +834,11 @@ GstPipelineClass
 GST_PIPELINE
 GST_IS_PIPELINE
 GST_TYPE_PIPELINE
-gst_pipeline_get_type
 GST_PIPELINE_CLASS
 GST_IS_PIPELINE_CLASS
 GST_PIPELINE_GET_CLASS
+<SUBSECTION Private>
+gst_pipeline_get_type
 </SECTION>
 
 <SECTION>
@@ -837,25 +860,27 @@ GstPluginFeatureClass
 GST_PLUGIN_FEATURE
 GST_IS_PLUGIN_FEATURE
 GST_TYPE_PLUGIN_FEATURE
-gst_plugin_feature_get_type
 GST_PLUGIN_FEATURE_CLASS
 GST_IS_PLUGIN_FEATURE_CLASS
 GST_PLUGIN_FEATURE_GET_CLASS
+<SUBSECTION Private>
+gst_plugin_feature_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstqueue</FILE>
 <TITLE>GstQueue</TITLE>
 GstQueue
-GstQueueClass
 GstQueueSize
 <SUBSECTION Standard>
+GstQueueClass
 GST_QUEUE
 GST_IS_QUEUE
 GST_TYPE_QUEUE
-gst_queue_get_type
 GST_QUEUE_CLASS
 GST_IS_QUEUE_CLASS
+<SUBSECTION Private>
+gst_queue_get_type
 </SECTION>
 
 <SECTION>
@@ -895,16 +920,16 @@ GstRegistryClass
 GST_REGISTRY
 GST_IS_REGISTRY
 GST_TYPE_REGISTRY
-gst_registry_get_type
 GST_REGISTRY_CLASS
 GST_IS_REGISTRY_CLASS
 GST_REGISTRY_GET_CLASS
+<SUBSECTION Private>
+gst_registry_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gstscheduler</FILE>
 GstScheduler
-GstSchedulerClass
 GstSchedulerFlags
 GST_SCHEDULER_PARENT
 GST_SCHEDULER_STATE
@@ -934,16 +959,9 @@ gst_scheduler_get_clock
 gst_scheduler_auto_clock
 gst_scheduler_show
 GST_TYPE_SCHEDULER_FACTORY
-GST_SCHEDULER_FACTORY
-GST_IS_SCHEDULER_FACTORY
-GST_SCHEDULER_FACTORY_CLASS
-GST_IS_SCHEDULER_FACTORY_CLASS
-GST_SCHEDULER_FACTORY_GET_CLASS
 GST_SCHEDULER_DEFAULT_NAME
 <TITLE>GstSchedulerFactory</TITLE>
 GstSchedulerFactory
-GstSchedulerFactoryClass
-gst_scheduler_factory_get_type
 gst_scheduler_factory_new
 gst_scheduler_factory_destroy
 gst_scheduler_factory_find
@@ -952,13 +970,22 @@ gst_scheduler_factory_make
 gst_scheduler_factory_set_default_name
 gst_scheduler_factory_get_default_name
 <SUBSECTION Standard>
+GstSchedulerClass
 GST_SCHEDULER
 GST_IS_SCHEDULER
 GST_TYPE_SCHEDULER
-gst_scheduler_get_type
 GST_SCHEDULER_CLASS
 GST_IS_SCHEDULER_CLASS
 GST_SCHEDULER_GET_CLASS
+GstSchedulerFactoryClass
+GST_SCHEDULER_FACTORY
+GST_IS_SCHEDULER_FACTORY
+GST_SCHEDULER_FACTORY_CLASS
+GST_IS_SCHEDULER_FACTORY_CLASS
+GST_SCHEDULER_FACTORY_GET_CLASS
+<SUBSECTION Private>
+gst_scheduler_get_type
+gst_scheduler_factory_get_type
 </SECTION>
 
 <SECTION>
@@ -1000,6 +1027,7 @@ gst_structure_from_string
 GST_STRUCTURE
 GST_IS_STRUCTURE
 GST_TYPE_STRUCTURE
+<SUBSECTION Private>
 gst_structure_get_type
 </SECTION>
 
@@ -1118,11 +1146,13 @@ GST_TAG_ALBUM_PEAK
 <SUBSECTION Standard>
 GST_TAG_FLAG_IS_VALID
 GST_TAG_MODE_IS_VALID
+<SUBSECTION Private>
 gst_tag_list_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gsttaginterface</FILE>
+<FILE>gsttagsetter</FILE>
+<TITLE>GstTagSetter</TITLE>
 GstTagSetter
 GstTagSetterIFace
 gst_tag_setter_merge
@@ -1137,9 +1167,10 @@ gst_tag_setter_get_merge_mode
 GST_TAG_SETTER
 GST_IS_TAG_SETTER
 GST_TYPE_TAG_SETTER
-gst_tag_setter_get_type
 GST_TAG_SETTER_CLASS
 GST_TAG_SETTER_GET_IFACE
+<SUBSECTION Private>
+gst_tag_setter_get_type
 </SECTION>
 
 <SECTION>
@@ -1156,14 +1187,16 @@ GstThreadClass
 GST_THREAD
 GST_IS_THREAD
 GST_TYPE_THREAD
-gst_thread_get_type
 GST_THREAD_CLASS
 GST_IS_THREAD_CLASS
 GST_THREAD_GET_CLASS
+<SUBSECTION Private>
+gst_thread_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gsttypefind</FILE>
+<TITLE>GstTypeFind</TITLE>
 GstTypeFind
 GstTypeFindFunction
 GstTypeFindProbability
@@ -1182,22 +1215,19 @@ GstTypeFindFactoryClass
 GST_TYPE_FIND_FACTORY
 GST_IS_TYPE_FIND_FACTORY
 GST_TYPE_TYPE_FIND_FACTORY
-gst_type_find_factory_get_type
 GST_TYPE_FIND_FACTORY_CLASS
 GST_IS_TYPE_FIND_FACTORY_CLASS
 GST_TYPE_FIND_FACTORY_GET_CLASS
+<SUBSECTION Private>
+gst_type_find_factory_get_type
 </SECTION>
 
 <SECTION>
 <FILE>gsturi</FILE>
 GstURIType
 GST_TYPE_URI_HANDLER
-GST_URI_HANDLER
-GST_IS_URI_HANDLER
-GST_URI_HANDLER_GET_INTERFACE
-GST_URI_HANDLER_CLASS
 GstURIHandler
-GstURIHandlerInterface
+GST_URI_TYPE_IS_VALID
 gst_uri_protocol_is_valid
 gst_uri_is_valid
 gst_uri_get_protocol
@@ -1210,7 +1240,12 @@ gst_uri_handler_get_uri
 gst_uri_handler_set_uri
 gst_uri_handler_new_uri
 <SUBSECTION Standard>
-GST_URI_TYPE_IS_VALID
+GstURIHandlerInterface
+GST_URI_HANDLER
+GST_IS_URI_HANDLER
+GST_URI_HANDLER_CLASS
+GST_URI_HANDLER_GET_INTERFACE
+<SUBSECTION Private>
 gst_uri_handler_get_type
 </SECTION>
 
@@ -1233,10 +1268,11 @@ GstXMLClass
 GST_XML
 GST_IS_XML
 GST_TYPE_XML
-gst_xml_get_type
 GST_XML_CLASS
 GST_IS_XML_CLASS
 GST_XML_GET_CLASS
+<SUBSECTION Private>
+gst_xml_get_type
 </SECTION>
 
 <SECTION>
@@ -1267,102 +1303,103 @@ gst_atomic_int_dec_and_test
 
 <SECTION>
 <FILE>gstenumtypes</FILE>
-gst_object_flags_get_type
-GST_TYPE_OBJECT_FLAGS
-gst_bin_flags_get_type
+GST_TYPE_ALLOC_TRACE_FLAGS
+GST_TYPE_ASSOC_FLAGS
 GST_TYPE_BIN_FLAGS
-gst_buffer_flag_get_type
 GST_TYPE_BUFFER_FLAG
-gst_clock_entry_status_get_type
 GST_TYPE_CLOCK_ENTRY_STATUS
-gst_clock_entry_type_get_type
 GST_TYPE_CLOCK_ENTRY_TYPE
-gst_clock_return_get_type
-GST_TYPE_CLOCK_RETURN
-gst_clock_flags_get_type
 GST_TYPE_CLOCK_FLAGS
-gst_cpu_flags_get_type
+GST_TYPE_CLOCK_RETURN
+GST_TYPE_CORE_ERROR
 GST_TYPE_CPU_FLAGS
-gst_data_flags_get_type
 GST_TYPE_DATA_FLAGS
-gst_element_flags_get_type
+GST_TYPE_DEBUG_COLOR_FLAGS
+GST_TYPE_DEBUG_LEVEL
 GST_TYPE_ELEMENT_FLAGS
-gst_core_error_get_type
-GST_TYPE_CORE_ERROR
-gst_library_error_get_type
-GST_TYPE_LIBRARY_ERROR
-gst_resource_error_get_type
-GST_TYPE_RESOURCE_ERROR
-gst_stream_error_get_type
-GST_TYPE_STREAM_ERROR
-gst_event_type_get_type
-GST_TYPE_EVENT_TYPE
-gst_event_flag_get_type
+GST_TYPE_ELEMENT_STATE
+GST_TYPE_ELEMENT_STATE_RETURN
 GST_TYPE_EVENT_FLAG
-gst_seek_type_get_type
-GST_TYPE_SEEK_TYPE
-gst_seek_accuracy_get_type
-GST_TYPE_SEEK_ACCURACY
-gst_format_get_type
+GST_TYPE_EVENT_TYPE
 GST_TYPE_FORMAT
-gst_index_certainty_get_type
 GST_TYPE_INDEX_CERTAINTY
-gst_index_entry_type_get_type
 GST_TYPE_INDEX_ENTRY_TYPE
-gst_index_lookup_method_get_type
+GST_TYPE_INDEX_FLAGS
 GST_TYPE_INDEX_LOOKUP_METHOD
-gst_assoc_flags_get_type
-GST_TYPE_ASSOC_FLAGS
-gst_index_resolver_method_get_type
 GST_TYPE_INDEX_RESOLVER_METHOD
-gst_index_flags_get_type
-GST_TYPE_INDEX_FLAGS
-gst_debug_level_get_type
-GST_TYPE_DEBUG_LEVEL
-gst_debug_color_flags_get_type
-GST_TYPE_DEBUG_COLOR_FLAGS
-gst_pad_link_return_get_type
-GST_TYPE_PAD_LINK_RETURN
-gst_pad_direction_get_type
+GST_TYPE_LIBRARY_ERROR
+GST_TYPE_OBJECT_FLAGS
 GST_TYPE_PAD_DIRECTION
-gst_pad_flags_get_type
 GST_TYPE_PAD_FLAGS
-gst_pad_presence_get_type
+GST_TYPE_PAD_LINK_RETURN
 GST_TYPE_PAD_PRESENCE
-gst_pad_template_flags_get_type
 GST_TYPE_PAD_TEMPLATE_FLAGS
-gst_plugin_error_get_type
+GST_TYPE_PARSE_ERROR
 GST_TYPE_PLUGIN_ERROR
-gst_query_type_get_type
 GST_TYPE_QUERY_TYPE
-gst_scheduler_flags_get_type
+GST_TYPE_REGISTRY_FLAGS
+GST_TYPE_REGISTRY_RETURN
+GST_TYPE_RESOURCE_ERROR
+GST_TYPE_RESULT
 GST_TYPE_SCHEDULER_FLAGS
-gst_scheduler_state_get_type
 GST_TYPE_SCHEDULER_STATE
-gst_tag_merge_mode_get_type
-GST_TYPE_TAG_MERGE_MODE
-gst_tag_flag_get_type
+GST_TYPE_SEEK_ACCURACY
+GST_TYPE_SEEK_TYPE
+GST_TYPE_STREAM_ERROR
 GST_TYPE_TAG_FLAG
-gst_thread_state_get_type
+GST_TYPE_TAG_MERGE_MODE
 GST_TYPE_THREAD_STATE
-gst_alloc_trace_flags_get_type
-GST_TYPE_ALLOC_TRACE_FLAGS
-gst_type_find_probability_get_type
 GST_TYPE_TYPE_FIND_PROBABILITY
+GST_TYPE_URI_TYPE
+<SUBSECTION Private>
+gst_alloc_trace_flags_get_type
+gst_assoc_flags_get_type
+gst_bin_flags_get_type
+gst_buffer_flag_get_type
+gst_clock_entry_status_get_type
+gst_clock_entry_type_get_type
+gst_clock_flags_get_type
+gst_clock_return_get_type
+gst_core_error_get_type
+gst_cpu_flags_get_type
+gst_data_flags_get_type
+gst_debug_color_flags_get_type
+gst_debug_level_get_type
+gst_element_flags_get_type
 gst_element_state_get_type
-GST_TYPE_ELEMENT_STATE
 gst_element_state_return_get_type
-GST_TYPE_ELEMENT_STATE_RETURN
+gst_event_flag_get_type
+gst_event_type_get_type
+gst_format_get_type
+gst_index_certainty_get_type
+gst_index_entry_type_get_type
+gst_index_flags_get_type
+gst_index_lookup_method_get_type
+gst_index_resolver_method_get_type
+gst_library_error_get_type
+gst_object_flags_get_type
+gst_pad_direction_get_type
+gst_pad_flags_get_type
+gst_pad_link_return_get_type
+gst_pad_presence_get_type
+gst_pad_template_flags_get_type
+gst_parse_error_get_type
+gst_plugin_error_get_type
+gst_query_type_get_type
+gst_registry_flags_get_type
+gst_registry_return_get_type
+gst_resource_error_get_type
 gst_result_get_type
-GST_TYPE_RESULT
+gst_scheduler_flags_get_type
+gst_scheduler_state_get_type
+gst_seek_accuracy_get_type
+gst_seek_type_get_type
+gst_stream_error_get_type
+gst_tag_flag_get_type
+gst_tag_merge_mode_get_type
+gst_thread_state_get_type
+gst_type_find_probability_get_type
 gst_uri_type_get_type
-GST_TYPE_URI_TYPE
-gst_registry_return_get_type
-GST_TYPE_REGISTRY_RETURN
-gst_registry_flags_get_type
-GST_TYPE_REGISTRY_FLAGS
-gst_parse_error_get_type
-GST_TYPE_PARSE_ERROR
 </SECTION>
 
 <SECTION>
@@ -1486,6 +1523,7 @@ gst_mem_chunk_free
 
 <SECTION>
 <FILE>gstparse</FILE>
+<TITLE>GstParse</TITLE>
 gst_parse_error_quark
 GST_PARSE_ERROR
 GstParseError
@@ -1498,7 +1536,6 @@ gst_parse_launchv
 gst_plugin_error_quark
 GST_PLUGIN_ERROR
 GstPluginError
-GST_PLUGIN
 GstPlugin
 GstPluginDesc
 GstPluginInitFunc
@@ -1508,7 +1545,6 @@ GST_PLUGIN_DEFINE_STATIC
 GST_LICENSE_UNKNOWN
 GstPluginFilter
 GST_TYPE_PLUGIN
-gst_plugin_get_type
 gst_plugin_get_name
 gst_plugin_get_description
 gst_plugin_get_filename
@@ -1528,6 +1564,10 @@ gst_plugin_unload_plugin
 gst_plugin_add_feature
 gst_plugin_load
 gst_library_load
+<SUBSECTION Standard>
+GST_PLUGIN
+<SUBSECTION Private>
+gst_plugin_get_type
 </SECTION>
 
 <SECTION>
@@ -1615,39 +1655,16 @@ SMP_LOCK
 </SECTION>
 
 <SECTION>
-<FILE>gsttypes</FILE>
-GstObject
-GstObjectClass
-GstPad
-GstPadClass
-GstPadTemplate
-GstPadTemplateClass
-GstElement
-GstElementClass
-GstBin
-GstBinClass
-GstScheduler
-GstSchedulerClass
-GstEvent
-GstElementState
-GstElementStateReturn
-GstResult
-GST_RANK_PRIMARY
-GST_RANK_SECONDARY
-GST_RANK_MARGINAL
-GST_RANK_NONE
-GST_PADDING
-GST_PADDING_INIT
-</SECTION>
-
-<SECTION>
 <FILE>gsturitype</FILE>
+<TITLE>GstUri</TITLE>
 GST_TYPE_URI
+<SUBSECTION Private>
 gst_uri_get_uri_type
 </SECTION>
 
 <SECTION>
 <FILE>gstutils</FILE>
+<TITLE>GstUtils</TITLE>
 gst_util_set_value_from_string
 gst_util_set_object_arg
 gst_util_dump_mem
@@ -1774,6 +1791,7 @@ gst_version
 
 <SECTION>
 <FILE>gsterror</FILE>
+<TITLE>GstGError</TITLE>
 GstCoreError
 GstLibraryError
 GstResourceError
@@ -1784,11 +1802,26 @@ GST_RESOURCE_ERROR
 GST_CORE_ERROR
 GST_STREAM_ERROR
 GST_ERROR_SYSTEM
-gst_g_error_get_type
 gst_error_get_message
 gst_stream_error_quark
 gst_core_error_quark
 gst_resource_error_quark
 gst_library_error_quark
+<SUBSECTION Private>
+gst_g_error_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gsttypes</FILE>
+GstElementState
+GstElementStateReturn
+GstResult
+GST_RANK_PRIMARY
+GST_RANK_SECONDARY
+GST_RANK_MARGINAL
+GST_RANK_NONE
+GST_PADDING
+GST_PADDING_INIT
+<SUBSECTION Standard>
 </SECTION>
 

diff --git a/docs/gst/gstreamer.types b/docs/gst/gstreamer.types
index 91cfa7d..6e9544c 100644 (file)
--- a/docs/gst/gstreamer.types
+++ b/docs/gst/gstreamer.types
@@ -1,21 +1,24 @@
 #include <gst/gst.h>
 #include <gst/gstqueue.h>
 
-gst_object_get_type
-gst_element_get_type
 gst_bin_get_type
 gst_clock_get_type
-gst_pipeline_get_type
+gst_element_factory_get_type
+gst_element_get_type
+gst_ghost_pad_get_type
+gst_implements_interface_get_type
+gst_index_factory_get_type
+gst_index_get_type
+gst_object_get_type
 gst_pad_get_type
 gst_pad_template_get_type
-gst_ghost_pad_get_type
-gst_thread_get_type
+gst_pipeline_get_type
 gst_plugin_feature_get_type
-gst_type_find_factory_get_type
-gst_element_factory_get_type
+gst_queue_get_type
 gst_scheduler_factory_get_type
 gst_scheduler_get_type
-gst_index_get_type
-gst_index_factory_get_type
+gst_tag_setter_get_type
+gst_thread_get_type
+gst_type_find_factory_get_type
 gst_xml_get_type
-gst_queue_get_type
+

diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index ed71bc4..7f48bdd 100644 (file)
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -55,6 +55,40 @@ clock providers in the bin.
 
 </para>
 
+<!-- ##### STRUCT GstBin ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GstBin::element-added ##### -->
+<para>
+
+</para>
+
+@gstbin: the object which received the signal.
+@arg1: the element that was added to the bin
+
+<!-- ##### SIGNAL GstBin::element-removed ##### -->
+<para>
+
+</para>
+
+@gstbin: the object which received the signal.
+@arg1: the element that was removed from the bin
+
+<!-- ##### SIGNAL GstBin::iterate ##### -->
+<para>
+This signal is emitted when a bin iterates, either automatically or
+due to a #gst_bin_iterate() call.  The return value is used to
+determine if the object method handler processed any data.
+In most normal cases, a user-provided signal handler should return
+FALSE.
+</para>
+
+@gstbin: the object which received the signal.
+@Returns: TRUE if the state of the bin was advanced.
+
 <!-- ##### ENUM GstBinFlags ##### -->
 <para>
 Flags for a bin.

diff --git a/docs/gst/tmpl/gstconfig.sgml b/docs/gst/tmpl/gstconfig.sgml
index 16c15e5..83d755f 100644 (file)
--- a/docs/gst/tmpl/gstconfig.sgml
+++ b/docs/gst/tmpl/gstconfig.sgml
@@ -6,7 +6,7 @@ Configuration options
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-This describes the configureation options for GStreamer. When building 
+This describes the configuration options for GStreamer. When building 
 GStreamer there are a lot of parts (known internally as "subsystems" ) that can 
 be disabled for various reasons. The most common reasons are speed and size, 
 which is important because GStreamer is designed to run on embedded systems.

diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml
index 6263b4e..9cb0d30 100644 (file)
--- a/docs/gst/tmpl/gstelement.sgml
+++ b/docs/gst/tmpl/gstelement.sgml
@@ -152,41 +152,12 @@ and gst_element_set_clock().  You can wait for the clock to reach a given
 @arg1: 
 @arg2: 
 
-<!-- ##### STRUCT GstElementClass ##### -->
+<!-- ##### MACRO GST_TYPE_ELEMENT ##### -->
 <para>
 
 </para>
 
-@parent_class: 
-@details: 
-@elementfactory: 
-@padtemplates: 
-@numpadtemplates: 
-@state_change: 
-@new_pad: 
-@pad_removed: 
-@error: 
-@eos: 
-@found_tag: 
-@set_property: 
-@get_property: 
-@release_locks: 
-@get_event_masks: 
-@send_event: 
-@get_formats: 
-@convert: 
-@get_query_types: 
-@query: 
-@change_state: 
-@request_new_pad: 
-@release_pad: 
-@get_clock: 
-@set_clock: 
-@get_index: 
-@set_index: 
-@set_state: 
-@no_more_pads: 
-@_gst_reserved: 
+
 
 <!-- ##### STRUCT GstElementDetails ##### -->
 <para>
@@ -292,14 +263,6 @@ The Element is going from the READY state to the NULL state.
 
 
 
-<!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
 <!-- ##### MACRO GST_ELEMENT_QUERY_TYPE_FUNCTION ##### -->
 <para>
 Helper macro to create query type functions
@@ -1255,14 +1218,6 @@ Sets the parent of an element.
 @element: 
 
 
-<!-- ##### FUNCTION gst_element_factory_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_element_register ##### -->
 <para>
 
@@ -1413,14 +1368,6 @@ Sets the parent of an element.
 </para>
 
 
-<!-- ##### STRUCT GstElementFactoryClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@_gst_reserved: 
-
 <!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
 <para>
 
@@ -1428,35 +1375,3 @@ Sets the parent of an element.
 
 
 
-<!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
-<!-- ##### MACRO GST_IS_ELEMENT_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_IS_ELEMENT_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-

diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml
index 1cd3b59..7d12cec 100644 (file)
--- a/docs/gst/tmpl/gstenumtypes.sgml
+++ b/docs/gst/tmpl/gstenumtypes.sgml
@@ -14,27 +14,18 @@ gstenumtypes
 
 </para>
 
-<!-- ##### FUNCTION gst_object_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
+<!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_bin_flags_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_BIN_FLAGS ##### -->
@@ -44,14 +35,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_buffer_flag_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_BUFFER_FLAG ##### -->
 <para>
 
@@ -59,14 +42,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_clock_entry_status_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_STATUS ##### -->
 <para>
 
@@ -74,14 +49,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_clock_entry_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_TYPE ##### -->
 <para>
 
@@ -89,12 +56,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_clock_return_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_CLOCK_RETURN ##### -->
@@ -104,27 +70,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_clock_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_cpu_flags_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_CPU_FLAGS ##### -->
@@ -134,14 +84,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_data_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_DATA_FLAGS ##### -->
 <para>
 
@@ -149,102 +91,39 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_element_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_core_error_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_library_error_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_resource_error_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_stream_error_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
+<!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_event_type_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
+<!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_event_flag_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_EVENT_FLAG ##### -->
@@ -254,42 +133,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_seek_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_seek_accuracy_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_format_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_FORMAT ##### -->
@@ -299,14 +147,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_index_certainty_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_INDEX_CERTAINTY ##### -->
 <para>
 
@@ -314,14 +154,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_index_entry_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_INDEX_ENTRY_TYPE ##### -->
 <para>
 
@@ -329,12 +161,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_index_lookup_method_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_INDEX_LOOKUP_METHOD ##### -->
@@ -344,29 +175,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_assoc_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_index_resolver_method_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_INDEX_RESOLVER_METHOD ##### -->
 <para>
 
@@ -374,72 +182,18 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_index_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_debug_level_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_debug_color_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_pad_link_return_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
+<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_pad_direction_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_PAD_DIRECTION ##### -->
@@ -449,14 +203,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_pad_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_PAD_FLAGS ##### -->
 <para>
 
@@ -464,12 +210,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_pad_presence_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_PAD_PRESENCE ##### -->
@@ -479,14 +224,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_pad_template_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_PAD_TEMPLATE_FLAGS ##### -->
 <para>
 
@@ -494,12 +231,11 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_plugin_error_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_PLUGIN_ERROR ##### -->
@@ -509,14 +245,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_query_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_QUERY_TYPE ##### -->
 <para>
 
@@ -524,102 +252,88 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_scheduler_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
+<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_scheduler_state_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
+<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_tag_merge_mode_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_RESULT ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
+<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_tag_flag_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
+<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_thread_state_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
+<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_alloc_trace_flags_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
+<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### FUNCTION gst_type_find_probability_get_type ##### -->
+<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
 <para>
 
 </para>
 
-@Returns: 
 
 
 <!-- ##### MACRO GST_TYPE_TYPE_FIND_PROBABILITY ##### -->
@@ -629,59 +343,6 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_element_state_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_element_state_return_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_result_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_RESULT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_uri_type_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### MACRO GST_TYPE_URI_TYPE ##### -->
 <para>
 
@@ -689,48 +350,3 @@ gstenumtypes
 
 
 
-<!-- ##### FUNCTION gst_registry_return_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_registry_flags_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_parse_error_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### -->
-<para>
-
-</para>
-
-
-

diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml
index 369c591..6a59eec 100644 (file)
--- a/docs/gst/tmpl/gsterror.sgml
+++ b/docs/gst/tmpl/gsterror.sgml
@@ -126,14 +126,6 @@ Categorized error messages
 
 
 
-<!-- ##### FUNCTION gst_g_error_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_error_get_message ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml
index c9e12a9..7ba8e19 100644 (file)
--- a/docs/gst/tmpl/gstevent.sgml
+++ b/docs/gst/tmpl/gstevent.sgml
@@ -27,6 +27,23 @@ gst_event_new_flush() creates a new flush event.
 #GstPad, #GstElement
 </para>
 
+<!-- ##### MACRO GST_TYPE_EVENT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### STRUCT GstEvent ##### -->
+<para>
+
+</para>
+
+@data: 
+@type: 
+@timestamp: 
+@src: 
+
 <!-- ##### ENUM GstEventType ##### -->
 <para>
 The different major types of events.
@@ -308,16 +325,6 @@ Get access to the rate vale field
 @event: The event to query
 
 
-<!-- ##### STRUCT GstEvent ##### -->
-<para>
-
-</para>
-
-@data: 
-@type: 
-@timestamp: 
-@src: 
-
 <!-- ##### FUNCTION gst_event_new ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstinterface.sgml b/docs/gst/tmpl/gstimplementsinterface.sgml
similarity index 80%
rename from docs/gst/tmpl/gstinterface.sgml
rename to docs/gst/tmpl/gstimplementsinterface.sgml
index 10754ef..907dfa1 100644 (file)
--- a/docs/gst/tmpl/gstinterface.sgml
+++ b/docs/gst/tmpl/gstimplementsinterface.sgml
@@ -1,8 +1,8 @@
 <!-- ##### SECTION Title ##### -->
-GstInterface
+GstImplementsInterface
 
 <!-- ##### SECTION Short_Description ##### -->
-Core interfaces implemented by #GstElements
+Core interface implemented by #GstElements that allows runtime querying of interface availabillity
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -14,6 +14,13 @@ Core interfaces implemented by #GstElements
 
 </para>
 
+<!-- ##### MACRO GST_TYPE_IMPLEMENTS_INTERFACE ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### STRUCT GstImplementsInterface ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml
index 7e535c1..aef57d3 100644 (file)
--- a/docs/gst/tmpl/gstindex.sgml
+++ b/docs/gst/tmpl/gstindex.sgml
@@ -445,68 +445,12 @@ Check if the index can be written to
 
 
 
-<!-- ##### MACRO GST_INDEX_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_IS_INDEX_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_INDEX_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
-<!-- ##### MACRO GST_IS_INDEX_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
-<!-- ##### MACRO GST_INDEX_FACTORY_GET_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### STRUCT GstIndexFactory ##### -->
 <para>
 The GstIndexFactory object
 </para>
 
 
-<!-- ##### STRUCT GstIndexFactoryClass ##### -->
-<para>
-
-</para>
-
-@parent: 
-@_gst_reserved: 
-
-<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_index_factory_new ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml
index e91a04c..9bd3330 100644 (file)
--- a/docs/gst/tmpl/gstobject.sgml
+++ b/docs/gst/tmpl/gstobject.sgml
@@ -25,12 +25,58 @@ object.
 
 </para>
 
-<!-- ##### MACRO GST_OBJECT_CLASS ##### -->
+<!-- ##### STRUCT GstObject ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GstObject::deep-notify ##### -->
+<para>
+The deep notify signal is used to be notified of property changes.
+it is typically attached to the toplevel bin to receive notifications
+from all the elements contained in that bin.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the object that originated the signal
+@arg2: the property that changed
+
+<!-- ##### SIGNAL GstObject::object-saved ##### -->
+<para>
+Is trigered whenever a new object is saved to XML. You can connect to
+this signal to insert custom XML tags into the core XML.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the xmlNodePtr of the parent node
+
+<!-- ##### SIGNAL GstObject::parent-set ##### -->
+<para>
+Is emitted when the parent of an object is set.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the new parent
+
+<!-- ##### SIGNAL GstObject::parent-unset ##### -->
+<para>
+Is emitted when the parent of an object is unset.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the old parent
+
+<!-- ##### ARG GstObject:name ##### -->
+<para>
+The name of the object
+</para>
+
+<!-- ##### MACRO GST_TYPE_OBJECT ##### -->
 <para>
 
 </para>
 
-@klass: 
 
 
 <!-- ##### MACRO xmlNodePtr ##### -->

diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index 509ad98..f59232e 100644 (file)
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -63,14 +63,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 </para>
 
 
-<!-- ##### STRUCT GstPadClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@_gst_reserved: 
-
 <!-- ##### STRUCT GstRealPad ##### -->
 <para>
 
@@ -88,40 +80,26 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 
 </para>
 
-<!-- ##### STRUCT GstRealPadClass ##### -->
+<!-- ##### STRUCT GstPadTemplate ##### -->
 <para>
-
+The padtemplate object.
 </para>
 
-@parent_class: 
-@caps_nego_failed: 
-@linked: 
-@unlinked: 
-@appfixatefunc: 
-@_gst_reserved: 
 
-<!-- ##### STRUCT GstGhostPadClass ##### -->
+<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
 <para>
-
+This signal is fired when an element creates a pad from this 
+template.
 </para>
 
-@parent_class: 
-@_gst_reserved: 
-
-<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
-<para>
-
-</para>
-
-@obj: 
-
+@gstpadtemplate: the object which received the signal.
+@arg1: The pad that was created.
 
-<!-- ##### MACRO GST_PAD_CLASS ##### -->
+<!-- ##### MACRO GST_TYPE_PAD ##### -->
 <para>
 
 </para>
 
-@klass: 
 
 
 <!-- ##### MACRO GST_TYPE_REAL_PAD ##### -->
@@ -131,14 +109,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 
 
 
-<!-- ##### MACRO GST_IS_REAL_PAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### -->
 <para>
 
@@ -147,32 +117,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 @obj: 
 
 
-<!-- ##### MACRO GST_IS_REAL_PAD_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-<!-- # Unused Parameters # -->
-@obj: 
-
-
-<!-- ##### MACRO GST_REAL_PAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_REAL_PAD_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
 <!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
 <para>
 
@@ -180,14 +124,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 
 
 
-<!-- ##### MACRO GST_IS_GHOST_PAD ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
 <para>
 
@@ -196,17 +132,7 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 @obj: 
 
 
-<!-- ##### MACRO GST_IS_GHOST_PAD_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-<!-- # Unused Parameters # -->
-@obj: 
-
-
-<!-- ##### MACRO GST_GHOST_PAD ##### -->
+<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
 <para>
 
 </para>
@@ -214,14 +140,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 @obj: 
 
 
-<!-- ##### MACRO GST_GHOST_PAD_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
 <!-- ##### STRUCT GstStaticPadTemplate ##### -->
 <para>
 
@@ -807,40 +725,6 @@ Checks if the pad is a sink pad.
 
 
 
-<!-- ##### MACRO GST_PAD_TEMPLATE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_PAD_TEMPLATE_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
-<!-- ##### MACRO GST_IS_PAD_TEMPLATE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_IS_PAD_TEMPLATE_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-<!-- # Unused Parameters # -->
-@obj: 
-
-
 <!-- ##### ENUM GstPadPresence ##### -->
 <para>
 Indicates when this pad will become available.
@@ -910,22 +794,6 @@ Check if the properties of the padtemplate are fixed
 @caps: 
 
 
-<!-- ##### FUNCTION gst_real_pad_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
-<!-- ##### FUNCTION gst_ghost_pad_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_pad_new ##### -->
 <para>
 
@@ -1786,14 +1654,6 @@ Remove the probe from the pad
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_pad_template_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_pad_template_new ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml
index 0eaf7a4..0590e21 100644 (file)
--- a/docs/gst/tmpl/gstparse.sgml
+++ b/docs/gst/tmpl/gstparse.sgml
@@ -2,7 +2,7 @@
 gstparse
 
 <!-- ##### SECTION Short_Description ##### -->
-
+get a pipeline from a text pipeline description
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>

diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml
index ce74670..764b6b8 100644 (file)
--- a/docs/gst/tmpl/gstplugin.sgml
+++ b/docs/gst/tmpl/gstplugin.sgml
@@ -58,14 +58,6 @@ The plugin loading errors
 @GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
 @GST_PLUGIN_ERROR_NAME_MISMATCH: 
 
-<!-- ##### MACRO GST_PLUGIN ##### -->
-<para>
-
-</para>
-
-@plugin: 
-
-
 <!-- ##### STRUCT GstPlugin ##### -->
 <para>
 The plugin object
@@ -173,14 +165,6 @@ It will be called by the loader at statup.
 
 
 
-<!-- ##### FUNCTION gst_plugin_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_plugin_get_name ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml
index 5eb283a..477e851 100644 (file)
--- a/docs/gst/tmpl/gstqueue.sgml
+++ b/docs/gst/tmpl/gstqueue.sgml
@@ -112,17 +112,6 @@ The queue blocks by default.
 
 </para>
 
-<!-- ##### STRUCT GstQueueClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@underrun: 
-@running: 
-@overrun: 
-@_gst_reserved: 
-
 <!-- ##### STRUCT GstQueueSize ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml
index 67a27a4..46c5ff1 100644 (file)
--- a/docs/gst/tmpl/gstscheduler.sgml
+++ b/docs/gst/tmpl/gstscheduler.sgml
@@ -20,34 +20,6 @@ This is a base class for custom schedulers.
 </para>
 
 
-<!-- ##### STRUCT GstSchedulerClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@setup: 
-@reset: 
-@add_element: 
-@remove_element: 
-@add_scheduler: 
-@remove_scheduler: 
-@state_transition: 
-@scheduling_change: 
-@lock_element: 
-@unlock_element: 
-@yield: 
-@interrupt: 
-@error: 
-@pad_link: 
-@pad_unlink: 
-@pad_select: 
-@clock_wait: 
-@iterate: 
-@show: 
-@object_sync: 
-@_gst_reserved: 
-
 <!-- ##### ENUM GstSchedulerFlags ##### -->
 <para>
 Flags for the scheduler
@@ -307,48 +279,6 @@ The state of the scheduler
 
 
 
-<!-- ##### MACRO GST_SCHEDULER_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_SCHEDULER_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-
-
-<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY_CLASS ##### -->
-<para>
-
-</para>
-
-@klass: 
-<!-- # Unused Parameters # -->
-@obj: 
-
-
-<!-- ##### MACRO GST_SCHEDULER_FACTORY_GET_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
 <para>
 
@@ -362,22 +292,6 @@ The state of the scheduler
 </para>
 
 
-<!-- ##### STRUCT GstSchedulerFactoryClass ##### -->
-<para>
-
-</para>
-
-@parent: 
-@_gst_reserved: 
-
-<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsttaginterface.sgml b/docs/gst/tmpl/gsttagsetter.sgml
similarity index 98%
rename from docs/gst/tmpl/gsttaginterface.sgml
rename to docs/gst/tmpl/gsttagsetter.sgml
index 0dc5abb..4c55270 100644 (file)
--- a/docs/gst/tmpl/gsttaginterface.sgml
+++ b/docs/gst/tmpl/gsttagsetter.sgml
@@ -1,5 +1,5 @@
 <!-- ##### SECTION Title ##### -->
-GstTagInterface
+GstTagSetter
 
 <!-- ##### SECTION Short_Description ##### -->
 Element interface that allows setting and retrieval of media metadata

diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml
index 72f211e..ee43012 100644 (file)
--- a/docs/gst/tmpl/gsttypefind.sgml
+++ b/docs/gst/tmpl/gsttypefind.sgml
@@ -2,7 +2,7 @@
 GstTypeFindElement
 
 <!-- ##### SECTION Short_Description ##### -->
-
+typefinding subsystem
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>

diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml
index dcf6af2..dbf8240 100644 (file)
--- a/docs/gst/tmpl/gsttypes.sgml
+++ b/docs/gst/tmpl/gsttypes.sgml
@@ -14,300 +14,6 @@ gsttypes
 
 </para>
 
-<!-- ##### STRUCT GstObject ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstObject::deep-notify ##### -->
-<para>
-The deep notify signal is used to be notified of property changes.
-it is typically attached to the toplevel bin to receive notifications
-from all the elements contained in that bin.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the object that originated the signal
-@arg2: the property that changed
-
-<!-- ##### SIGNAL GstObject::object-saved ##### -->
-<para>
-Is trigered whenever a new object is saved to XML. You can connect to
-this signal to insert custom XML tags into the core XML.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the xmlNodePtr of the parent node
-
-<!-- ##### SIGNAL GstObject::parent-set ##### -->
-<para>
-Is emitted when the parent of an object is set.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the new parent
-
-<!-- ##### SIGNAL GstObject::parent-unset ##### -->
-<para>
-Is emitted when the parent of an object is unset.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the old parent
-
-<!-- ##### ARG GstObject:name ##### -->
-<para>
-The name of the object
-</para>
-
-<!-- ##### STRUCT GstObjectClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@path_string_separator: 
-@signal_object: 
-@parent_set: 
-@parent_unset: 
-@object_saved: 
-@deep_notify: 
-@destroy: 
-@save_thyself: 
-@restore_thyself: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstPad ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstPadClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstPadTemplate ##### -->
-<para>
-The padtemplate object.
-</para>
-
-
-<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
-<para>
-This signal is fired when an element creates a pad from this 
-template.
-</para>
-
-@gstpadtemplate: the object which received the signal.
-@arg1: The pad that was created.
-
-<!-- ##### STRUCT GstPadTemplateClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@pad_created: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstElement ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstElement::eos ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-
-<!-- ##### SIGNAL GstElement::error ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
-
-<!-- ##### SIGNAL GstElement::found-tag ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### SIGNAL GstElement::new-pad ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-
-<!-- ##### SIGNAL GstElement::no-more-pads ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-
-<!-- ##### SIGNAL GstElement::pad-removed ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-
-<!-- ##### SIGNAL GstElement::state-change ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### STRUCT GstElementClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@details: 
-@elementfactory: 
-@padtemplates: 
-@numpadtemplates: 
-@state_change: 
-@new_pad: 
-@pad_removed: 
-@error: 
-@eos: 
-@found_tag: 
-@set_property: 
-@get_property: 
-@release_locks: 
-@get_event_masks: 
-@send_event: 
-@get_formats: 
-@convert: 
-@get_query_types: 
-@query: 
-@change_state: 
-@request_new_pad: 
-@release_pad: 
-@get_clock: 
-@set_clock: 
-@get_index: 
-@set_index: 
-@set_state: 
-@no_more_pads: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstBin ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstBin::element-added ##### -->
-<para>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was added to the bin
-
-<!-- ##### SIGNAL GstBin::element-removed ##### -->
-<para>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was removed from the bin
-
-<!-- ##### SIGNAL GstBin::iterate ##### -->
-<para>
-This signal is emitted when a bin iterates, either automatically or
-due to a #gst_bin_iterate() call.  The return value is used to
-determine if the object method handler processed any data.
-In most normal cases, a user-provided signal handler should return
-FALSE.
-</para>
-
-@gstbin: the object which received the signal.
-@Returns: TRUE if the state of the bin was advanced.
-
-<!-- ##### STRUCT GstBinClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@add_element: 
-@remove_element: 
-@child_state_change: 
-@iterate: 
-@element_added: 
-@element_removed: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstScheduler ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GstSchedulerClass ##### -->
-<para>
-
-</para>
-
-@parent_class: 
-@setup: 
-@reset: 
-@add_element: 
-@remove_element: 
-@add_scheduler: 
-@remove_scheduler: 
-@state_transition: 
-@scheduling_change: 
-@lock_element: 
-@unlock_element: 
-@yield: 
-@interrupt: 
-@error: 
-@pad_link: 
-@pad_unlink: 
-@pad_select: 
-@clock_wait: 
-@iterate: 
-@show: 
-@object_sync: 
-@_gst_reserved: 
-
-<!-- ##### STRUCT GstEvent ##### -->
-<para>
-
-</para>
-
-@data: 
-@type: 
-@timestamp: 
-@src: 
-
 <!-- ##### ENUM GstElementState ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsturi.sgml b/docs/gst/tmpl/gsturi.sgml
index 89646ae..8c75213 100644 (file)
--- a/docs/gst/tmpl/gsturi.sgml
+++ b/docs/gst/tmpl/gsturi.sgml
@@ -31,56 +31,19 @@ and the element property that can handle a given URI.
 
 
 
-<!-- ##### MACRO GST_URI_HANDLER ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_IS_URI_HANDLER ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_URI_HANDLER_GET_INTERFACE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
-<!-- ##### MACRO GST_URI_HANDLER_CLASS ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### STRUCT GstURIHandler ##### -->
 <para>
 
 </para>
 
 
-<!-- ##### STRUCT GstURIHandlerInterface ##### -->
+<!-- ##### MACRO GST_URI_TYPE_IS_VALID ##### -->
 <para>
 
 </para>
 
-@parent: 
-@new_uri: 
-@get_type: 
-@get_protocols: 
-@get_uri: 
-@set_uri: 
-@_gst_reserved: 
+@type: 
+
 
 <!-- ##### FUNCTION gst_uri_protocol_is_valid ##### -->
 <para>

diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml
index 15ad3c7..6b9ca13 100644 (file)
--- a/docs/gst/tmpl/gsturitype.sgml
+++ b/docs/gst/tmpl/gsturitype.sgml
@@ -21,11 +21,3 @@ GstURIType
 
 
 
-<!-- ##### FUNCTION gst_uri_get_uri_type ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-

diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml
index 630ad43..b05d1aa 100644 (file)
--- a/docs/gst/tmpl/gstutils.sgml
+++ b/docs/gst/tmpl/gstutils.sgml
@@ -2,7 +2,7 @@
 gstutils
 
 <!-- ##### SECTION Short_Description ##### -->
-
+various utility functions
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>

diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml
index 7358e45..ccad08d 100644 (file)
--- a/docs/gst/tmpl/gstxml.sgml
+++ b/docs/gst/tmpl/gstxml.sgml
@@ -2,7 +2,7 @@
 GstXML
 
 <!-- ##### SECTION Short_Description ##### -->
-
+XML save/restore operations of pipelines
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>

diff --git a/docs/pwg/advanced-dparams.xml b/docs/pwg/advanced-dparams.xml
index 973c1eb..5e7abcc 100644 (file)
--- a/docs/pwg/advanced-dparams.xml
+++ b/docs/pwg/advanced-dparams.xml
@@ -50,7 +50,7 @@
       <row>
         <entry><emphasis>Frequency and resolution of updates</emphasis></entry>
         <entry>Object properties will only be updated between calls to _get, _chain or _loop</entry>
-        <entry>dparams can be updated at any rate independant of calls to _get, _chain or _loop up to sample-level accuracy</entry>
+        <entry>dparams can be updated at any rate independent of calls to _get, _chain or _loop up to sample-level accuracy</entry>
       </row>
       </tbody>
       </tgroup>
@@ -124,7 +124,7 @@
 </sect1>
 
 <sect1 id="section-dparam-define">
-  <title>Defining Parameter Specificiations</title>
+  <title>Defining Parameter Specifications</title>
   <para>
     You can define the dparams you need anywhere within your element but will
     usually need to do so in only a couple of places:
@@ -139,7 +139,7 @@
         <para>
         Whenever a new pad is created so that parameters can affect data going
         into or out of a specific pad. An example of this would be a mixer
-        element where a seperate volume parameter is needed on every pad.
+        element where a separate volume parameter is needed on every pad.
         </para>
       </listitem>
     </itemizedlist>
@@ -203,7 +203,7 @@
       This method is the simplest and has the lowest overhead for parameters
       which change less frequently than the sample rate. First you need
       somewhere to store the parameter - this will usually be in your element's
-      stuct.
+      struct.
     </para>
     <programlisting>
   struct _GstExample {
@@ -248,7 +248,7 @@
     <para>
       The following code illustrates an instance where you might want to use the
       callback method. If you had a volume dparam which was represented by a
-      gfloat number, your element may only deal with integer arithmatic. The
+      gfloat number, your element may only deal with integer arithmetic. The
       callback could be used to calculate the integer scaler when the volume
       changes. First you will need somewhere to store these values.
     </para>
@@ -281,7 +281,7 @@
   );
     </programlisting>
     <para>
-      The callback function needs to conform to this signiture
+      The callback function needs to conform to this signature
     </para>
     <programlisting>
 typedef void (*GstDPMUpdateFunction) (GValue *value, gpointer data);
@@ -335,7 +335,7 @@ gst_example_update_volume(GValue *value, gpointer data)
     <para>
       The array method is currently the least mature of the three methods and is
       not yet ready to be used in elements, but plugin writers should be aware
-      of its existance for the future.
+      of its existence for the future.
     </para>
   </sect2>
 </sect1>
@@ -491,7 +491,7 @@ example_chain (GstPad *pad, GstBuffer *buf)
     </para>
   </sect2>
   <sect2 id="section-dparam-audio-video">
-    <title>DParam Manager Modes</title>
+    <title>Dynamic Parameters for Video</title>
     <para>
       All of the explanation so far has presumed that the buffer contains audio
       data with many samples. Video should be regarded differently since a video

diff --git a/docs/pwg/advanced-events.xml b/docs/pwg/advanced-events.xml
index 3a63f20..5c51e66 100644 (file)
--- a/docs/pwg/advanced-events.xml
+++ b/docs/pwg/advanced-events.xml
@@ -1,7 +1,7 @@
 <chapter id="chapter-advanced-events">
   <title>Events: Seeking, Navigation and More</title>
   <para>
-    There are many different event types but only 2 ways they can travel accross
+    There are many different event types but only 2 ways they can travel across
     the pipeline: downstream or upstream. It is very important to understand
     how both of those methods work because if one element in the pipeline is not
     handling them correctly the whole event system of the pipeline is broken.
@@ -17,7 +17,7 @@
       or directly in the function call arguments. So when receiving dataflow
       from the sink pad you have to check first if this data chunk is an event.
       If that's the case you check what kind of event it is to react on relevant
-      ones and then forward others dowstream using
+      ones and then forward others downstream using
       <function>gst_pad_event_default</function>. Here is an example for both
       loop and chain based elements.
     </para>
@@ -157,7 +157,7 @@ gst_my_filter_handle_src_event (GstPad   *pad,
     <title>All Events Together</title>
     <para>
       In this chapter follows a list of all defined events that are currently
-      being used, plus how they should be used/interpretted. Events are stored
+      being used, plus how they should be used/interpreted. Events are stored
       in a <classname>GstEvent</classname> structure, which is simply a big
       C union with the types for each event in it. For the next development
       cycle, we intend to switch events over to <classname>GstStructure</classname>,
@@ -186,7 +186,7 @@ gst_my_filter_handle_src_event (GstPad   *pad,
         downstream and set itself to EOS (<function>gst_element_set_eos ()</function>).
         <function>gst_pad_event_default ()</function> takes care of all this,
         so most elements do not need to support this event. Exceptions are
-        elements that explicitely need to close a resource down on EOS, and
+        elements that explicitly need to close a resource down on EOS, and
         N-to-1 elements. Note that the stream itself is <emphasis>not</emphasis>
         a resource that should be closed down on EOS! Applications might seek
         back to a point before EOS and set the pipeline to PLAYING again.

diff --git a/docs/pwg/building-boiler.xml b/docs/pwg/building-boiler.xml
index 95df88f..8773102 100644 (file)
--- a/docs/pwg/building-boiler.xml
+++ b/docs/pwg/building-boiler.xml
@@ -174,7 +174,7 @@ U gst-template/gst-app/src/Makefile.am
   <sect1 id="section-boiler-details">
     <title>GstElementDetails</title>
     <para>
-      The GstElementDetails structure gives a heirarchical type for the element,
+      The GstElementDetails structure gives a hierarchical type for the element,
       a human-readable description of the element, as well as author and version
       data. The entries are:
     </para>
@@ -182,7 +182,7 @@ U gst-template/gst-app/src/Makefile.am
       <listitem><para>
         A long, english, name for the element.
       </para></listitem><listitem><para>
-        The type of the element, as a heirarchy. The heirarchy is defined by
+        The type of the element, as a hierarchy. The hierarchy is defined by
         specifying the top level category, followed by a "/", followed by the
         next level category, etc. The type should be defined according to the
         guidelines elsewhere in this document. (FIXME: write the guidelines, and

diff --git a/docs/random/ensonic/dparams.txt b/docs/random/ensonic/dparams.txt
index 77a6cc6..875b223 100644 (file)
--- a/docs/random/ensonic/dparams.txt
+++ b/docs/random/ensonic/dparams.txt
@@ -1,11 +1,21 @@
 $Id$
 
 * cleanup of dparams
+  * even though it is long try to stick to the prefix "dparam" for the whole library
+      * e.g. avoid namespace clashes with "dataprotocol" which is using "dp" as well :-(
   * resolve g_return_if_fail() into GST_WARNING and return()
     in cases where the caller has to handle the problem
   * rename
     GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH
     GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT
     there seems to be nobody using them, as they still look unfinished
+  * move modes into extra modules
+    dparam_mode_synchronous
+    dparam_mode_asynchronous
+    dparam_mode_disabled
+
+* documentation
+  * state of unitconvert
+  * state of sychronous params
 
 * concept for global, voice params

diff --git a/docs/random/ensonic/interfaces.txt b/docs/random/ensonic/interfaces.txt
new file mode 100644 (file)
index 0000000..4291f63
--- /dev/null
+++ b/docs/random/ensonic/interfaces.txt
@@ -0,0 +1,32 @@
+$Id$
+
+* new general interfaces
+  * GST_TYPE_PRESET_MANAGER
+    - add preset managment
+    - API:
+      GList *get_presets();
+      void activate_preset_by_index(glong index);
+      void activate_preset_by_name(const gchar *name);
+      void add_current(const gchar *name);
+      void remove_preset_by_index(glong index);
+      void remove_preset_by_name(const gchar *name);
+    - features
+      - there should always be a default preset
+    - questions
+      - were and how do we store the presets?
+
+  * GST_TYPE_UI_HINT
+    - add hints to generate 'good' looking interfaces to elements
+    - API:
+    - features
+      - grouping of parameters
+
+* new interfaces for audio applications
+  * GST_TYPE_MUSIC_GENERATOR
+    - add hints so that application can find out which params to use to
+      play notes and/or to trigger sounds
+    - API:
+      DParam *get_note_dparam();
+      DParam *get_trigger_dparam();
+    - questions
+      - can we use this to support multiple voices?

diff --git a/gst/gsterror.h b/gst/gsterror.h
index ea7f124..9ffac98 100644 (file)
--- a/gst/gsterror.h
+++ b/gst/gsterror.h
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
  * the core GStreamer library */
 /* FIXME: should we divide in numerical blocks so we can easily add
           for example PAD errors later ? */
-    typedef enum
+typedef enum
 {
   GST_CORE_ERROR_FAILED = 1,
   GST_CORE_ERROR_TOO_LAZY,

diff --git a/gst/gstinterface.h b/gst/gstinterface.h
index 8cd5ba3..391a312 100644 (file)
--- a/gst/gstinterface.h
+++ b/gst/gstinterface.h
@@ -45,11 +45,13 @@ G_BEGIN_DECLS
 
 typedef struct _GstImplementsInterface GstImplementsInterface;
 
+typedef struct _GstImplementsInterfaceClass GstImplementsInterfaceClass;
+
 /* This small extra virtual function is here to provide an
  * interface functionality on a per-instance basis rather
  * than a per-class basis, which is the case for glib.
  */
-typedef struct _GstImplementsInterfaceClass {
+struct _GstImplementsInterfaceClass {
   GTypeInterface parent;
 
   /* virtual functions */
@@ -57,7 +59,7 @@ typedef struct _GstImplementsInterfaceClass {
                          GType                   iface_type);
 
   gpointer _gst_reserved[GST_PADDING];
-} GstImplementsInterfaceClass;
+};
 
 #define GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST(obj, type, cast_t) \
   ((cast_t *) gst_implements_interface_cast ((obj), (type)))

diff --git a/gst/gstparse.h b/gst/gstparse.h
index a63fa24..b3221a9 100644 (file)
--- a/gst/gstparse.h
+++ b/gst/gstparse.h
@@ -2,7 +2,7 @@
  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
  *                    2000 Wim Taymans <wtay@chello.be>
  *
- * filename:
+ * gstparse.h: get a pipeline from a text pipeline description
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public

diff --git a/gst/gstxml.h b/gst/gstxml.h
index db34c26..0ab06f8 100644 (file)
--- a/gst/gstxml.h
+++ b/gst/gstxml.h
@@ -2,7 +2,7 @@
  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
  *                    2000 Wim Taymans <wim.taymans@chello.be>
  *
- * gstxml.h: Header for XML save/restore operations
+ * gstxml.h: Header for XML save/restore operations of pipelines
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public

diff --git a/libs/gst/control/control.c b/libs/gst/control/control.c
index e5c530e..7501444 100644 (file)
--- a/libs/gst/control/control.c
+++ b/libs/gst/control/control.c
@@ -26,6 +26,13 @@
 GST_DEBUG_CATEGORY (_gst_control_debug);
 #define GST_CAT_DEFAULT _gst_control_debug
 
+/**
+ * gst_control_init:
+ * @argc: pointer to application's argc
+ * @argv: pointer to application's argv
+ *
+ * Initializes the GStreamer control library, registering modes and units
+ */
 void
 gst_control_init (int *argc, char **argv[])
 {