added documentation to many items moved the GST_TYPE_XXX one to the Standart section...

Original commit message from CVS:
added documentation to many items
moved the GST_TYPE_XXX one to the Standart section, as they do not need docs

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 1aff424..8bdd9a6 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -258,6 +258,8 @@ gst_clock_get_type
 <SECTION>
 <FILE>gstcompat</FILE>
 <TITLE>GstCompat</TITLE>
+<SUBSECTION Standard>
+GST_PAD_IS_CONNECTED
 gst_element_connect
 gst_element_connect_pads
 gst_element_connect_many
@@ -277,8 +279,8 @@ GST_PAD_CONNECT_DONE
 GstPadConnectReturn
 GstPadConnectFunction
 gst_info
-<SUBSECTION Standard>
-GST_PAD_IS_CONNECTED
+<SUBSECTION Private>
+
 </SECTION>
 
 <SECTION>
@@ -314,7 +316,6 @@ GST_DATA_TYPE
 GST_DATA_FLAGS
 GST_DATA_FLAG_SHIFT
 GST_DATA_FLAG_UNSET
-GST_TYPE_DATA
 GstData
 GstDataFreeFunction
 GstDataCopyFunction
@@ -333,6 +334,7 @@ gst_data_ref
 gst_data_ref_by_count
 gst_data_unref
 <SUBSECTION Standard>
+GST_TYPE_DATA
 GST_DATA_FLAG_SET
 GST_DATA_FLAG_IS_SET
 <SUBSECTION Private>
@@ -343,7 +345,6 @@ gst_data_get_type
 <FILE>gstelement</FILE>
 <TITLE>GstElement</TITLE>
 GstElement
-GST_TYPE_ELEMENT
 GST_NUM_STATES
 GST_STATE
 GST_STATE_PENDING
@@ -459,6 +460,7 @@ GST_IS_ELEMENT
 GST_ELEMENT_CLASS
 GST_IS_ELEMENT_CLASS
 GST_ELEMENT_GET_CLASS
+GST_TYPE_ELEMENT
 <SUBSECTION Private>
 gst_element_get_type
 </SECTION>
@@ -475,7 +477,6 @@ GST_IS_ELEMENT_DETAILS
 <SECTION>
 <FILE>gstelementfactory</FILE>
 <TITLE>GstElementFactory</TITLE>
-GST_TYPE_ELEMENT_FACTORY
 GstElementFactory
 gst_element_register
 gst_element_factory_find
@@ -498,6 +499,7 @@ GST_ELEMENT_FACTORY
 GST_IS_ELEMENT_FACTORY
 GST_ELEMENT_FACTORY_CLASS
 GST_IS_ELEMENT_FACTORY_CLASS
+GST_TYPE_ELEMENT_FACTORY
 <SUBSECTION Private>
 gst_element_factory_get_type
 </SECTION>
@@ -505,6 +507,7 @@ gst_element_factory_get_type
 <SECTION>
 <FILE>gstenumtypes</FILE>
 <TITLE>GstEnumTypes</TITLE>
+<SUBSECTION Standard>
 GST_TYPE_ALLOC_TRACE_FLAGS
 GST_TYPE_ASSOC_FLAGS
 GST_TYPE_BIN_FLAGS
@@ -543,6 +546,7 @@ GST_TYPE_REGISTRY_FLAGS
 GST_TYPE_REGISTRY_RETURN
 GST_TYPE_RESOURCE_ERROR
 GST_TYPE_RESULT
+GST_TYPE_RANK
 GST_TYPE_SCHEDULER_FLAGS
 GST_TYPE_SCHEDULER_STATE
 GST_TYPE_SEEK_ACCURACY
@@ -592,6 +596,7 @@ gst_registry_flags_get_type
 gst_registry_return_get_type
 gst_resource_error_get_type
 gst_result_get_type
+gst_rank_get_type
 gst_scheduler_flags_get_type
 gst_scheduler_state_get_type
 gst_seek_accuracy_get_type
@@ -611,7 +616,6 @@ GstCoreError
 GstLibraryError
 GstResourceError
 GstStreamError
-GST_TYPE_G_ERROR
 GST_LIBRARY_ERROR
 GST_RESOURCE_ERROR
 GST_CORE_ERROR
@@ -622,6 +626,8 @@ gst_stream_error_quark
 gst_core_error_quark
 gst_resource_error_quark
 gst_library_error_quark
+<SUBSECTION Standard>
+GST_TYPE_G_ERROR
 <SUBSECTION Private>
 gst_g_error_get_type
 </SECTION>
@@ -629,7 +635,6 @@ gst_g_error_get_type
 <SECTION>
 <FILE>gstevent</FILE>
 <TITLE>GstEvent</TITLE>
-GST_TYPE_EVENT
 GstEvent
 GstEventType
 GST_EVENT_ANY
@@ -678,6 +683,7 @@ gst_event_new_flush
 <SUBSECTION Standard>
 GST_EVENT
 GST_IS_EVENT
+GST_TYPE_EVENT
 <SUBSECTION Private>
 gst_event_get_type
 </SECTION>
@@ -717,6 +723,7 @@ GST_GHOST_PAD
 GST_IS_GHOST_PAD
 GST_GHOST_PAD_CLASS
 GST_IS_GHOST_PAD_CLASS
+GST_TYPE_GHOST_PAD
 <SUBSECTION Private>
 gst_ghost_pad_get_type
 </SECTION>
@@ -725,7 +732,6 @@ gst_ghost_pad_get_type
 <FILE>gstindex</FILE>
 <TITLE>GstIndex</TITLE>
 GstIndex
-GST_TYPE_INDEX_ENTRY
 GstIndexEntry
 GstIndexGroup
 GstIndexCertainty
@@ -775,6 +781,7 @@ GST_TYPE_INDEX
 GST_INDEX_CLASS
 GST_IS_INDEX_CLASS
 GST_INDEX_GET_CLASS
+GST_TYPE_INDEX_ENTRY
 <SUBSECTION Private>
 gst_index_get_type
 </SECTION>
@@ -782,7 +789,6 @@ gst_index_get_type
 <SECTION>
 <FILE>gstindexfactory</FILE>
 <TITLE>GstIndexFactory</TITLE>
-GST_TYPE_INDEX_FACTORY
 GstIndexFactory
 gst_index_factory_new
 gst_index_factory_destroy
@@ -796,6 +802,7 @@ GST_IS_INDEX_FACTORY
 GST_INDEX_FACTORY_CLASS
 GST_IS_INDEX_FACTORY_CLASS
 GST_INDEX_FACTORY_GET_CLASS
+GST_TYPE_INDEX_FACTORY
 <SUBSECTION Private>
 gst_index_factory_get_type
 </SECTION>
@@ -806,9 +813,6 @@ gst_index_factory_get_type
 GstDebugLevel
 GST_LEVEL_DEFAULT
 GstDebugColorFlags
-GST_DEBUG_FG_MASK
-GST_DEBUG_BG_MASK
-GST_DEBUG_FORMAT_MASK
 GstDebugCategory
 GST_STR_NULL
 GST_DEBUG_PAD_NAME
@@ -874,12 +878,15 @@ gst_debug_category_unset_threshold_for_name
 gst_debug_print_stack_trace
 GST_TIME_FORMAT
 GST_TIME_ARGS
+<SUBSECTION Private>
+GST_DEBUG_FG_MASK
+GST_DEBUG_BG_MASK
+GST_DEBUG_FORMAT_MASK
 </SECTION>
 
 <SECTION>
 <FILE>gstimplementsinterface</FILE>
 <TITLE>GstImplementsInterface</TITLE>
-GST_TYPE_IMPLEMENTS_INTERFACE
 GstImplementsInterface
 GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST
 GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE
@@ -893,6 +900,7 @@ GST_IMPLEMENTS_INTERFACE_CLASS
 GST_IS_IMPLEMENTS_INTERFACE
 GST_IS_IMPLEMENTS_INTERFACE_CLASS
 GST_IMPLEMENTS_INTERFACE_GET_CLASS
+GST_TYPE_IMPLEMENTS_INTERFACE
 <SUBSECTION Private>
 gst_implements_interface_get_type
 </SECTION>
@@ -920,7 +928,6 @@ gst_mem_chunk_free
 <FILE>gstobject</FILE>
 <TITLE>GstObject</TITLE>
 GstObject
-GST_TYPE_OBJECT
 GstObjectFlags
 GST_FLAGS
 GST_FLAG_IS_SET
@@ -957,6 +964,7 @@ GST_IS_OBJECT
 GST_OBJECT_CLASS
 GST_IS_OBJECT_CLASS
 GST_OBJECT_GET_CLASS
+GST_TYPE_OBJECT
 <SUBSECTION Private>
 gst_object_get_type
 xmlNodePtr
@@ -1006,7 +1014,6 @@ GST_PAD_IS_USABLE
 GST_PAD_CAN_PULL
 GST_PAD_IS_SRC
 GST_PAD_IS_SINK
-GST_TYPE_PAD_TEMPLATE
 GstPadPresence
 gst_pad_new
 gst_pad_new_from_template
@@ -1102,6 +1109,7 @@ GST_PAD
 GST_IS_PAD
 GST_PAD_CLASS
 GST_IS_PAD_CLASS
+GST_TYPE_PAD
 <SUBSECTION Private>
 gst_pad_get_type
 </SECTION>
@@ -1111,8 +1119,6 @@ gst_pad_get_type
 <TITLE>GstPadTemplate</TITLE>
 GstPadTemplate
 GstStaticPadTemplate
-GST_TYPE_PAD
-GST_TYPE_GHOST_PAD
 GST_IS_GHOST_PAD_FAST
 GST_IS_PAD_FAST
 GST_PAD_TEMPLATE_NAME_TEMPLATE
@@ -1132,6 +1138,7 @@ GST_IS_PAD_TEMPLATE
 GST_PAD_TEMPLATE_CLASS
 GST_IS_PAD_TEMPLATE_CLASS
 GST_STATIC_PAD_TEMPLATE
+GST_TYPE_PAD_TEMPLATE
 <SUBSECTION Private>
 gst_pad_template_get_type
 </SECTION>
@@ -1155,10 +1162,10 @@ gst_pipeline_new
 GstPipelineClass
 GST_PIPELINE
 GST_IS_PIPELINE
-GST_TYPE_PIPELINE
 GST_PIPELINE_CLASS
 GST_IS_PIPELINE_CLASS
 GST_PIPELINE_GET_CLASS
+GST_TYPE_PIPELINE
 <SUBSECTION Private>
 gst_pipeline_get_type
 </SECTION>
@@ -1177,7 +1184,6 @@ GST_PLUGIN_DEFINE
 GST_PLUGIN_DEFINE_STATIC
 GST_LICENSE_UNKNOWN
 GstPluginFilter
-GST_TYPE_PLUGIN
 gst_plugin_get_name
 gst_plugin_get_description
 gst_plugin_get_filename
@@ -1199,6 +1205,7 @@ gst_plugin_load
 gst_library_load
 <SUBSECTION Standard>
 GST_PLUGIN
+GST_TYPE_PLUGIN
 <SUBSECTION Private>
 gst_plugin_get_type
 </SECTION>
@@ -1221,10 +1228,10 @@ gst_plugin_feature_get_name
 GstPluginFeatureClass
 GST_PLUGIN_FEATURE
 GST_IS_PLUGIN_FEATURE
-GST_TYPE_PLUGIN_FEATURE
 GST_PLUGIN_FEATURE_CLASS
 GST_IS_PLUGIN_FEATURE_CLASS
 GST_PLUGIN_FEATURE_GET_CLASS
+GST_TYPE_PLUGIN_FEATURE
 <SUBSECTION Private>
 gst_plugin_feature_get_type
 </SECTION>
@@ -1270,9 +1277,9 @@ GstQueueSize
 GstQueueClass
 GST_QUEUE
 GST_IS_QUEUE
-GST_TYPE_QUEUE
 GST_QUEUE_CLASS
 GST_IS_QUEUE_CLASS
+GST_TYPE_QUEUE
 <SUBSECTION Private>
 gst_queue_get_type
 </SECTION>
@@ -1282,7 +1289,6 @@ gst_queue_get_type
 <FILE>gstrealpad</FILE>
 <TITLE>GstRealPad</TITLE>
 GstRealPad
-GST_TYPE_REAL_PAD
 GST_IS_REAL_PAD_FAST
 GST_RPAD_DIRECTION
 GST_RPAD_CAPS
@@ -1313,6 +1319,7 @@ GST_REAL_PAD
 GST_IS_REAL_PAD
 GST_REAL_PAD_CLASS
 GST_IS_REAL_PAD_CLASS
+GST_TYPE_REAL_PAD
 <SUBSECTION Private>
 gst_real_pad_get_type
 </SECTION>
@@ -1353,10 +1360,10 @@ gst_registry_update_plugin
 GstRegistryClass
 GST_REGISTRY
 GST_IS_REGISTRY
-GST_TYPE_REGISTRY
 GST_REGISTRY_CLASS
 GST_IS_REGISTRY_CLASS
 GST_REGISTRY_GET_CLASS
+GST_TYPE_REGISTRY
 <SUBSECTION Private>
 gst_registry_get_type
 </SECTION>
@@ -1414,10 +1421,10 @@ GST_SCHEDULER_DEFAULT_NAME
 GstSchedulerClass
 GST_SCHEDULER
 GST_IS_SCHEDULER
-GST_TYPE_SCHEDULER
 GST_SCHEDULER_CLASS
 GST_IS_SCHEDULER_CLASS
 GST_SCHEDULER_GET_CLASS
+GST_TYPE_SCHEDULER
 <SUBSECTION Private>
 gst_scheduler_get_type
 </SECTION>
@@ -1426,7 +1433,6 @@ gst_scheduler_get_type
 <FILE>gstschedulerfactory</FILE>
 <TITLE>GstSchedulerFactory</TITLE>
 GstSchedulerFactory
-GST_TYPE_SCHEDULER_FACTORY
 gst_scheduler_register
 gst_scheduler_factory_new
 gst_scheduler_factory_destroy
@@ -1442,6 +1448,7 @@ GST_IS_SCHEDULER_FACTORY
 GST_SCHEDULER_FACTORY_CLASS
 GST_IS_SCHEDULER_FACTORY_CLASS
 GST_SCHEDULER_FACTORY_GET_CLASS
+GST_TYPE_SCHEDULER_FACTORY
 <SUBSECTION Private>
 gst_scheduler_factory_get_type
 </SECTION>
@@ -1449,7 +1456,6 @@ gst_scheduler_factory_get_type
 <SECTION>
 <FILE>gststructure</FILE>
 <TITLE>GstStructure</TITLE>
-GST_TYPE_STRUCTURE
 GstStructure
 GstStructureForeachFunc
 gst_structure_empty_new
@@ -1486,6 +1492,7 @@ gst_structure_from_string
 <SUBSECTION Standard>
 GST_STRUCTURE
 GST_IS_STRUCTURE
+GST_TYPE_STRUCTURE
 <SUBSECTION Private>
 gst_structure_get_type
 </SECTION>
@@ -1494,7 +1501,6 @@ gst_structure_get_type
 <FILE>gstsystemclock</FILE>
 <TITLE>GstSystemClock</TITLE>
 GstSystemClock
-GST_TYPE_SYSTEM_CLOCK
 gst_system_clock_obtain
 <SUBSECTION Standard>
 GstSystemClockClass
@@ -1504,13 +1510,13 @@ gst_system_clock_get_type
 GST_SYSTEM_CLOCK_CLASS
 GST_IS_SYSTEM_CLOCK_CLASS
 GST_SYSTEM_CLOCK_GET_CLASS
+GST_TYPE_SYSTEM_CLOCK
 </SECTION>
 
 <SECTION>
 <FILE>gsttaglist</FILE>
 <TITLE>GstTagList</TITLE>
 GstTagList
-GST_TYPE_TAG_LIST
 GstTagMergeMode
 GstTagFlag
 GstTagForeachFunc
@@ -1606,6 +1612,7 @@ GST_TAG_LIST
 GST_IS_TAG_LIST
 GST_TAG_FLAG_IS_VALID
 GST_TAG_MODE_IS_VALID
+GST_TYPE_TAG_LIST
 <SUBSECTION Private>
 gst_tag_list_get_type
 </SECTION>
@@ -1615,7 +1622,6 @@ gst_tag_list_get_type
 <TITLE>GstTagSetter</TITLE>
 GstTagSetter
 GstTagSetterIFace
-GST_TYPE_TAG_SETTER
 gst_tag_setter_merge
 gst_tag_setter_add
 gst_tag_setter_add_values
@@ -1629,6 +1635,7 @@ GST_TAG_SETTER
 GST_IS_TAG_SETTER
 GST_TAG_SETTER_CLASS
 GST_TAG_SETTER_GET_IFACE
+GST_TYPE_TAG_SETTER
 <SUBSECTION Private>
 gst_tag_setter_get_type
 </SECTION>
@@ -1637,7 +1644,6 @@ gst_tag_setter_get_type
 <FILE>gstthread</FILE>
 <TITLE>GstThread</TITLE>
 GstThread
-GST_TYPE_THREAD
 gst_thread_current
 GstThreadState
 gst_thread_new
@@ -1650,6 +1656,7 @@ GST_IS_THREAD
 GST_THREAD_CLASS
 GST_IS_THREAD_CLASS
 GST_THREAD_GET_CLASS
+GST_TYPE_THREAD
 <SUBSECTION Private>
 gst_thread_get_type
 </SECTION>
@@ -1712,7 +1719,6 @@ gst_type_find_register
 <FILE>gsttypefindfactory</FILE>
 <TITLE>GstTypeFindFactory</TITLE>
 GstTypeFindFactory
-GST_TYPE_TYPE_FIND_FACTORY
 gst_type_find_factory_get_list
 gst_type_find_factory_get_extensions
 gst_type_find_factory_get_caps
@@ -1724,6 +1730,7 @@ GST_IS_TYPE_FIND_FACTORY
 GST_TYPE_FIND_FACTORY_CLASS
 GST_IS_TYPE_FIND_FACTORY_CLASS
 GST_TYPE_FIND_FACTORY_GET_CLASS
+GST_TYPE_TYPE_FIND_FACTORY
 <SUBSECTION Private>
 gst_type_find_factory_get_type
 </SECTION>
@@ -1734,10 +1741,7 @@ gst_type_find_factory_get_type
 GstElementState
 GstElementStateReturn
 GstResult
-GST_RANK_PRIMARY
-GST_RANK_SECONDARY
-GST_RANK_MARGINAL
-GST_RANK_NONE
+GstRank
 GST_PADDING
 GST_PADDING_INIT
 <SUBSECTION Standard>
@@ -1747,7 +1751,6 @@ GST_PADDING_INIT
 <FILE>gsturihandler</FILE>
 <TITLE>GstUriHandler</TITLE>
 GstURIHandler
-GST_TYPE_URI_HANDLER
 GST_URI_TYPE_IS_VALID
 gst_uri_protocol_is_valid
 gst_uri_is_valid
@@ -1766,6 +1769,7 @@ GST_URI_HANDLER
 GST_IS_URI_HANDLER
 GST_URI_HANDLER_CLASS
 GST_URI_HANDLER_GET_INTERFACE
+GST_TYPE_URI_HANDLER
 <SUBSECTION Private>
 gst_uri_handler_get_type
 </SECTION>
@@ -1774,6 +1778,7 @@ gst_uri_handler_get_type
 <FILE>gsturitype</FILE>
 <TITLE>GstUriType</TITLE>
 GstURIType
+<SUBSECTION Standard>
 GST_TYPE_URI
 <SUBSECTION Private>
 gst_uri_get_uri_type
@@ -1822,12 +1827,6 @@ GST_VALUE_HOLDS_LIST
 GST_VALUE_HOLDS_FIXED_LIST
 GST_VALUE_HOLDS_CAPS
 GST_VALUE_HOLDS_FRACTION
-GST_TYPE_FOURCC
-GST_TYPE_INT_RANGE
-GST_TYPE_DOUBLE_RANGE
-GST_TYPE_LIST
-GST_TYPE_FIXED_LIST
-GST_TYPE_FRACTION
 GST_VALUE_LESS_THAN
 GST_VALUE_EQUAL
 GST_VALUE_GREATER_THAN
@@ -1874,6 +1873,13 @@ gst_value_register_subtract_func
 gst_value_intersect
 gst_value_can_intersect
 gst_value_register_intersect_func
+<SUBSECTION Standard>
+GST_TYPE_FOURCC
+GST_TYPE_INT_RANGE
+GST_TYPE_DOUBLE_RANGE
+GST_TYPE_LIST
+GST_TYPE_FIXED_LIST
+GST_TYPE_FRACTION
 </SECTION>
 
 <SECTION>
@@ -1902,10 +1908,10 @@ gst_xml_make_element
 GstXMLClass
 GST_XML
 GST_IS_XML
-GST_TYPE_XML
 GST_XML_CLASS
 GST_IS_XML_CLASS
 GST_XML_GET_CLASS
+GST_TYPE_XML
 <SUBSECTION Private>
 gst_xml_get_type
 </SECTION>

diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index 7f48bdd..2b29fb1 100644 (file)
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -63,7 +63,7 @@ clock providers in the bin.
 
 <!-- ##### SIGNAL GstBin::element-added ##### -->
 <para>
-
+Will be emmited if a new element was removed/added to this bin.
 </para>
 
 @gstbin: the object which received the signal.
@@ -71,7 +71,7 @@ clock providers in the bin.
 
 <!-- ##### SIGNAL GstBin::element-removed ##### -->
 <para>
-
+Will be emmited if an element was removed from this bin.
 </para>
 
 @gstbin: the object which received the signal.

diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml
index fda83c9..56000aa 100644 (file)
--- a/docs/gst/tmpl/gstbuffer.sgml
+++ b/docs/gst/tmpl/gstbuffer.sgml
@@ -282,10 +282,10 @@ Copies the given buffer using the copy function of the parent GstData structure.
 
 <!-- ##### MACRO gst_buffer_is_writable ##### -->
 <para>
-
+Tests if you can safely write data into a buffer's data array.
 </para>
 
-@buf: 
+@buf: a #GstBuffer to check
 
 
 <!-- ##### MACRO gst_buffer_copy_on_write ##### -->

diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml
index 10d7335..7cba16c 100644 (file)
--- a/docs/gst/tmpl/gstcaps.sgml
+++ b/docs/gst/tmpl/gstcaps.sgml
@@ -16,37 +16,43 @@ Structure describing sets of media formats
 
 <!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
 <para>
-
+Flags that this caps has no specific content, but can contain anything.
 </para>
 
 
 
 <!-- ##### MACRO GST_CAPS_ANY ##### -->
 <para>
-
+Means that the element/pad can output 'anything'. Useful for elements
+that output unknown media, such as filesrc.
 </para>
 
 
 
 <!-- ##### MACRO GST_CAPS_NONE ##### -->
 <para>
-
+The opposite of GST_CAPS_ANY: it means that the pad/element outputs an
+undefined media type that can not be detected.
 </para>
 
 
 
 <!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
 <para>
-
+Creates a static caps that matches anything. This can be used in pad
+templates.
 </para>
 
+@Returns: a new #GstCaps instance
 
 
 <!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
 <para>
-
+Creates a static caps that matches nothing. This can be used in pad
+templates.
 </para>
 
+@Returns: a new #GstCaps instance
 
 
 <!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
@@ -76,10 +82,12 @@ Structure describing sets of media formats
 
 <!-- ##### MACRO GST_STATIC_CAPS ##### -->
 <para>
-
+Creates a static caps from an input string. This can be used in pad
+templates.
 </para>
 
-@string: 
+@string: the string describing the caps.
+@Returns: a new #GstCaps instance
 
 
 <!-- ##### MACRO GST_STATIC_CAPS_PREFERRED ##### -->

diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml
index e2742ea..ba67b5b 100644 (file)
--- a/docs/gst/tmpl/gstcompat.sgml
+++ b/docs/gst/tmpl/gstcompat.sgml
@@ -2,11 +2,12 @@
 GstCompat
 
 <!-- ##### SECTION Short_Description ##### -->
-Deprecated API entries
+Deprecated API entries.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+Please do not use in new code. This symbols are hidden by the GST_DISABLE_DEPRECATED define.
+One would have to add this to the CFLAGS when compiling old code.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,166 +15,3 @@ Deprecated API entries
 
 </para>
 
-<!-- ##### MACRO gst_element_connect ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### MACRO gst_element_connect_pads ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-@c: 
-@d: 
-
-
-<!-- ##### MACRO gst_element_connect_many ##### -->
-<para>
-
-</para>
-
-@a: 
-@...: 
-
-
-<!-- ##### MACRO gst_element_connect_filtered ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-@c: 
-
-
-<!-- ##### MACRO gst_element_disconnect ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### MACRO gst_pad_connect ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### MACRO gst_pad_connect_filtered ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-@c: 
-
-
-<!-- ##### MACRO gst_pad_disconnect ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### MACRO gst_pad_proxy_connect ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### MACRO gst_pad_set_connect_function ##### -->
-<para>
-
-</para>
-
-@a: 
-@b: 
-
-
-<!-- ##### FUNCTION gst_pad_call_chain_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@data: 
-
-
-<!-- ##### FUNCTION gst_pad_call_get_function ##### -->
-<para>
-
-</para>
-
-@pad: 
-@Returns: 
-
-
-<!-- ##### MACRO GST_PAD_CONNECT_REFUSED ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_PAD_CONNECT_DELAYED ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_PAD_CONNECT_OK ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_PAD_CONNECT_DONE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### TYPEDEF GstPadConnectReturn ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### TYPEDEF GstPadConnectFunction ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO gst_info ##### -->
-<para>
-
-</para>
-
-@...: 
-<!-- # Unused Parameters # -->
-@format: 
-@args...: 
-
-

diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml
index 1b5673e..d7e2c65 100644 (file)
--- a/docs/gst/tmpl/gstdata.sgml
+++ b/docs/gst/tmpl/gstdata.sgml
@@ -57,13 +57,6 @@ Unset the given flag
 @flag: The flag to unset
 
 
-<!-- ##### MACRO GST_TYPE_DATA ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstData ##### -->
 <para>
 The base structure

diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml
index fe5f2b3..1a1dd83 100644 (file)
--- a/docs/gst/tmpl/gstelement.sgml
+++ b/docs/gst/tmpl/gstelement.sgml
@@ -152,13 +152,6 @@ and gst_element_set_clock().  You can wait for the clock to reach a given
 @arg1: 
 @arg2: 
 
-<!-- ##### MACRO GST_TYPE_ELEMENT ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GST_NUM_STATES ##### -->
 <para>
 The maximun number of states.

diff --git a/docs/gst/tmpl/gstelementfactory.sgml b/docs/gst/tmpl/gstelementfactory.sgml
index 17f7f8f..aac5b9f 100644 (file)
--- a/docs/gst/tmpl/gstelementfactory.sgml
+++ b/docs/gst/tmpl/gstelementfactory.sgml
@@ -54,13 +54,6 @@ so that the autopluggers can select a plugin more appropriatly
 #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
 </para>
 
-<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstElementFactory ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml
index ecc0dd7..16a3375 100644 (file)
--- a/docs/gst/tmpl/gstenumtypes.sgml
+++ b/docs/gst/tmpl/gstenumtypes.sgml
@@ -14,339 +14,3 @@ GstEnumTypes
 
 </para>
 
-<!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_BIN_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_BUFFER_FLAG ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_STATUS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CLOCK_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_CPU_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_DATA_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_EVENT_FLAG ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_CERTAINTY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_ENTRY_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_LOOKUP_METHOD ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INDEX_RESOLVER_METHOD ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PAD_DIRECTION ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PAD_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PAD_PRESENCE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_PLUGIN_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_QUERY_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_RESULT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_TYPE_FIND_PROBABILITY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_URI_TYPE ##### -->
-<para>
-
-</para>
-
-
-

diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml
index 6a59eec..888b33e 100644 (file)
--- a/docs/gst/tmpl/gsterror.sgml
+++ b/docs/gst/tmpl/gsterror.sgml
@@ -84,13 +84,6 @@ Categorized error messages
 @GST_STREAM_ERROR_FORMAT: 
 @GST_STREAM_ERROR_NUM_ERRORS: 
 
-<!-- ##### MACRO GST_TYPE_G_ERROR ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GST_LIBRARY_ERROR ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml
index 21a7619..953aaa6 100644 (file)
--- a/docs/gst/tmpl/gstevent.sgml
+++ b/docs/gst/tmpl/gstevent.sgml
@@ -27,13 +27,6 @@ gst_event_new_flush() creates a new flush event.
 #GstPad, #GstElement
 </para>
 
-<!-- ##### MACRO GST_TYPE_EVENT ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstEvent ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstimplementsinterface.sgml b/docs/gst/tmpl/gstimplementsinterface.sgml
index 907dfa1..5683450 100644 (file)
--- a/docs/gst/tmpl/gstimplementsinterface.sgml
+++ b/docs/gst/tmpl/gstimplementsinterface.sgml
@@ -14,13 +14,6 @@ Core interface implemented by #GstElements that allows runtime querying of inter
 
 </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 255969e..04a60a2 100644 (file)
--- a/docs/gst/tmpl/gstindex.sgml
+++ b/docs/gst/tmpl/gstindex.sgml
@@ -34,13 +34,6 @@ Is emited when a new entry is added to the index.
 
 </para>
 
-<!-- ##### MACRO GST_TYPE_INDEX_ENTRY ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstIndexEntry ##### -->
 <para>
 The basic element of an index.

diff --git a/docs/gst/tmpl/gstindexfactory.sgml b/docs/gst/tmpl/gstindexfactory.sgml
index 7e72305..f458efd 100644 (file)
--- a/docs/gst/tmpl/gstindexfactory.sgml
+++ b/docs/gst/tmpl/gstindexfactory.sgml
@@ -14,13 +14,6 @@ GstIndexFactory is used to dynamically create GstIndex implementations.
 #GstIndex
 </para>
 
-<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstIndexFactory ##### -->
 <para>
 The GstIndexFactory object

diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml
index b7e2a24..d877e51 100644 (file)
--- a/docs/gst/tmpl/gstinfo.sgml
+++ b/docs/gst/tmpl/gstinfo.sgml
@@ -135,27 +135,6 @@ categories to make them stand out in debugging output.
 @GST_DEBUG_BOLD: Make the output bold.
 @GST_DEBUG_UNDERLINE: Underline the output.
 
-<!-- ##### MACRO GST_DEBUG_FG_MASK ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_DEBUG_BG_MASK ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_DEBUG_FORMAT_MASK ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstDebugCategory ##### -->
 <para>
 This is the struct that describes the categories. Once initialized with

diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml
index 235b763..d5c09f5 100644 (file)
--- a/docs/gst/tmpl/gstobject.sgml
+++ b/docs/gst/tmpl/gstobject.sgml
@@ -72,13 +72,6 @@ Is emitted when the parent of an object is unset.
 The name of the object
 </para>
 
-<!-- ##### MACRO GST_TYPE_OBJECT ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### ENUM GstObjectFlags ##### -->
 <para>
 Flags for an object

diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index 3c53762..c386b91 100644 (file)
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -83,18 +83,20 @@ The result of a pad link.
 
 <!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
 <para>
-
+Macro to test if the given #GstPadLinkReturn value indicates a
+failed negotiation step (REFUSED/DELAYED).
 </para>
 
-@ret: 
+@ret: the #GstPadLinkReturn value
 
 
 <!-- ##### MACRO GST_PAD_LINK_SUCCESSFUL ##### -->
 <para>
-
+Macro to test if the given #GstPadLinkReturn value indicates a
+successfull negotiation step (OK/DONE).
 </para>
 
-@ret: 
+@ret: the #GstPadLinkReturn value
 
 
 <!-- ##### MACRO GST_PAD_QUERY_TYPE_FUNCTION ##### -->
@@ -439,13 +441,6 @@ Checks if the pad is a sink pad.
 @pad: a #GstPad to check.
 
 
-<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### ENUM GstPadPresence ##### -->
 <para>
 Indicates when this pad will become available.

diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml
index 1ae66c7..ce843c0 100644 (file)
--- a/docs/gst/tmpl/gstpadtemplate.sgml
+++ b/docs/gst/tmpl/gstpadtemplate.sgml
@@ -98,20 +98,6 @@ template.
 @presence: 
 @static_caps: 
 
-<!-- ##### MACRO GST_TYPE_PAD ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml
index 126c963..e042b50 100644 (file)
--- a/docs/gst/tmpl/gstplugin.sgml
+++ b/docs/gst/tmpl/gstplugin.sgml
@@ -6,12 +6,12 @@ Container for features loaded from a shared object module
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
+GStreamer is extensible, so <classname>GstElements</classname> can be loaded at runtime. A plugin
 system can provide one or more of the basic <application>GStreamer</application> 
 #GstPluginFeature subclasses.
 </para>
 <para>
-A plugin should export a symbol plugin_desc that is a struct of type #GstPluginDesc. 
+A plugin should export a symbol <symbol>plugin_desc</symbol> that is a struct of type #GstPluginDesc. 
 the plugin loader will check the version of the core library the plugin was linked against
 and will create a new #GstPlugin. It will then call the #GstPluginInitFunc function
 that was provided in the plugin_desc.
@@ -20,7 +20,7 @@ that was provided in the plugin_desc.
 Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature.
 </para>
 <para>
-use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.
+Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.
 </para>
 <para>
 Usually plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly 
@@ -160,13 +160,6 @@ One would use this macro to define a local plugin that can only be used by the o
 @Returns: 
 
 
-<!-- ##### MACRO GST_TYPE_PLUGIN ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### FUNCTION gst_plugin_get_name ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml
index 477e851..71ce9c5 100644 (file)
--- a/docs/gst/tmpl/gstqueue.sgml
+++ b/docs/gst/tmpl/gstqueue.sgml
@@ -33,7 +33,10 @@ The queue blocks by default.
 
 <!-- ##### SIGNAL GstQueue::overrun ##### -->
 <para>
-
+Reports that the buffer became full (overrun).
+A buffer is full if the total amount of data inside it (num-buffers, time,
+size) is higher than the boundary values which can be set through the GObject
+properties.
 </para>
 
 @gstqueue: the object which received the signal.
@@ -47,7 +50,10 @@ The queue blocks by default.
 
 <!-- ##### SIGNAL GstQueue::underrun ##### -->
 <para>
-
+Reports that the buffer became empty (underrun).
+A buffer is empty if the total amount of data inside it (num-buffers, time,
+size) is lower than the boundary values which can be set through the GObject
+properties.
 </para>
 
 @gstqueue: the object which received the signal.

diff --git a/docs/gst/tmpl/gstschedulerfactory.sgml b/docs/gst/tmpl/gstschedulerfactory.sgml
index ebc48da..a9a5313 100644 (file)
--- a/docs/gst/tmpl/gstschedulerfactory.sgml
+++ b/docs/gst/tmpl/gstschedulerfactory.sgml
@@ -37,13 +37,6 @@ Use gst_scheduler_factory_destroy() to remove the factory from the global list.
 </para>
 
 
-<!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### FUNCTION gst_scheduler_register ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml
index 122fb20..a0b2b7e 100644 (file)
--- a/docs/gst/tmpl/gststructure.sgml
+++ b/docs/gst/tmpl/gststructure.sgml
@@ -14,13 +14,6 @@ Generic structure containing fields of names and values
 
 </para>
 
-<!-- ##### MACRO GST_TYPE_STRUCTURE ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT GstStructure ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml
index c8afc01..1f5f6eb 100644 (file)
--- a/docs/gst/tmpl/gstsystemclock.sgml
+++ b/docs/gst/tmpl/gstsystemclock.sgml
@@ -25,13 +25,6 @@ system time.
 @cond: 
 @_gst_reserved: 
 
-<!-- ##### MACRO GST_TYPE_SYSTEM_CLOCK ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### FUNCTION gst_system_clock_obtain ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsttaglist.sgml b/docs/gst/tmpl/gsttaglist.sgml
index d0c5164..64559f8 100644 (file)
--- a/docs/gst/tmpl/gsttaglist.sgml
+++ b/docs/gst/tmpl/gsttaglist.sgml
@@ -20,13 +20,6 @@ List of tags and values used to describe media metadata
 </para>
 
 
-<!-- ##### MACRO GST_TYPE_TAG_LIST ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### ENUM GstTagMergeMode ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsttagsetter.sgml b/docs/gst/tmpl/gsttagsetter.sgml
index a6aaa4b..4c55270 100644 (file)
--- a/docs/gst/tmpl/gsttagsetter.sgml
+++ b/docs/gst/tmpl/gsttagsetter.sgml
@@ -27,13 +27,6 @@ Element interface that allows setting and retrieval of media metadata
 
 @g_iface: 
 
-<!-- ##### MACRO GST_TYPE_TAG_SETTER ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### FUNCTION gst_tag_setter_merge ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml
index 96aae36..3bc2738 100644 (file)
--- a/docs/gst/tmpl/gstthread.sgml
+++ b/docs/gst/tmpl/gstthread.sgml
@@ -36,13 +36,6 @@ A Thread can act as a toplevel bin as it has its own scheduler.
 The thread priority
 </para>
 
-<!-- ##### MACRO GST_TYPE_THREAD ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### VARIABLE gst_thread_current ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsttypefindfactory.sgml b/docs/gst/tmpl/gsttypefindfactory.sgml
index a8aa9cf..9aea96a 100644 (file)
--- a/docs/gst/tmpl/gsttypefindfactory.sgml
+++ b/docs/gst/tmpl/gsttypefindfactory.sgml
@@ -73,13 +73,6 @@ Object that stores information about a typefind function
 </para>
 
 
-<!-- ##### MACRO GST_TYPE_TYPE_FIND_FACTORY ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### FUNCTION gst_type_find_factory_get_list ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml
index b56d58a..75548b5 100644 (file)
--- a/docs/gst/tmpl/gsttypes.sgml
+++ b/docs/gst/tmpl/gsttypes.sgml
@@ -16,23 +16,25 @@ various global enums and constants
 
 <!-- ##### ENUM GstElementState ##### -->
 <para>
-
+These contants describe the state a #GstElement is in and transition scheduled for the #GstElement (the pending state).
 </para>
 
-@GST_STATE_VOID_PENDING: 
-@GST_STATE_NULL: 
-@GST_STATE_READY: 
-@GST_STATE_PAUSED: 
-@GST_STATE_PLAYING: 
+@GST_STATE_VOID_PENDING: no transition is schedules for this element
+@GST_STATE_NULL: this is the default state all elements are in, after they have been created and are doing nothing
+@GST_STATE_READY: the element is ready to start doing something
+@GST_STATE_PAUSED: the element is paused for a period of time
+@GST_STATE_PLAYING: the element is doing something
 
 <!-- ##### ENUM GstElementStateReturn ##### -->
 <para>
-
+One of these values is returned from a gst_element_set_state() call.
+As GST_STATE_FAILURE is equal to 0, one can use a boolean comparission
+against the GstElementStateReturn value.
 </para>
 
-@GST_STATE_FAILURE: 
-@GST_STATE_SUCCESS: 
-@GST_STATE_ASYNC: 
+@GST_STATE_FAILURE: the state of the element could not be changed
+@GST_STATE_SUCCESS: the state of the element has already be changed
+@GST_STATE_ASYNC: the state of the element will change in the near future
 
 <!-- ##### ENUM GstResult ##### -->
 <para>
@@ -43,33 +45,20 @@ various global enums and constants
 @GST_RESULT_NOK: 
 @GST_RESULT_NOT_IMPL: 
 
-<!-- ##### MACRO GST_RANK_PRIMARY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_RANK_SECONDARY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_RANK_MARGINAL ##### -->
+<!-- ##### ENUM GstRank ##### -->
 <para>
-
+Element priority ranks. Defines the order in which the autoplugger (or similar
+rank-picking mechanisms) will choose this element over an alternative one
+with the same function.
+The rank is a unsigned integer ranging from 0 (GST_RANK_NONE) to 256 (GST_RANK_PRIMARY).
+These constants serve as a rough guidiance for defining the rank of a #GstPlugin using
+gst_plugin_feature_set_rank().
 </para>
 
-
-
-<!-- ##### MACRO GST_RANK_NONE ##### -->
-<para>
-
-</para>
-
-
+@GST_RANK_NONE: will be chosen last or not at all
+@GST_RANK_MARGINAL: unlikly to be chosen
+@GST_RANK_SECONDARY: likely to be chosen
+@GST_RANK_PRIMARY: will be chosen first
 
 <!-- ##### MACRO GST_PADDING ##### -->
 <para>

diff --git a/docs/gst/tmpl/gsturihandler.sgml b/docs/gst/tmpl/gsturihandler.sgml
index 29fa2d6..fb5512f 100644 (file)
--- a/docs/gst/tmpl/gsturihandler.sgml
+++ b/docs/gst/tmpl/gsturihandler.sgml
@@ -21,13 +21,6 @@ and the element property that can handle a given URI.
 </para>
 
 
-<!-- ##### MACRO GST_TYPE_URI_HANDLER ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GST_URI_TYPE_IS_VALID ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml
index 77aec06..99e0afc 100644 (file)
--- a/docs/gst/tmpl/gsturitype.sgml
+++ b/docs/gst/tmpl/gsturitype.sgml
@@ -23,10 +23,3 @@ describes URI types
 @GST_URI_SINK: 
 @GST_URI_SRC: 
 
-<!-- ##### MACRO GST_TYPE_URI ##### -->
-<para>
-
-</para>
-
-
-

diff --git a/docs/gst/tmpl/gstvalue.sgml b/docs/gst/tmpl/gstvalue.sgml
index 3ddac44..27ecf0c 100644 (file)
--- a/docs/gst/tmpl/gstvalue.sgml
+++ b/docs/gst/tmpl/gstvalue.sgml
@@ -16,13 +16,14 @@ GValue implementations specific to GStreamer
 
 <!-- ##### MACRO GST_MAKE_FOURCC ##### -->
 <para>
-
+will transform four characters into a host-endiannness guint32 fourcc:
+<code>guint32 fourcc = GST_MAKE_FOURCC ('M','J','P','G');</code>
 </para>
 
-@a: 
-@b: 
-@c: 
-@d: 
+@a: the first component
+@b: the second component
+@c: the third component
+@d: the fourth component
 
 
 <!-- ##### MACRO GST_STR_FOURCC ##### -->
@@ -35,17 +36,21 @@ GValue implementations specific to GStreamer
 
 <!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
 <para>
-
+Can be used to properly output a fourcc (a guint32) value in a
+printf()-style text message.
+<code>printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));</code>
 </para>
 
 
 
 <!-- ##### MACRO GST_FOURCC_ARGS ##### -->
 <para>
-
+Can be used to properly output a fourcc (a guint32) value in a
+printf()-style text message.
+<code>printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));</code>
 </para>
 
-@fourcc: 
+@fourcc: the fourcc value to print
 
 
 <!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
@@ -104,48 +109,6 @@ GValue implementations specific to GStreamer
 @x: 
 
 
-<!-- ##### MACRO GST_TYPE_FOURCC ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_INT_RANGE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_DOUBLE_RANGE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_LIST ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_FIXED_LIST ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GST_TYPE_FRACTION ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
 <para>
 

diff --git a/gst/gstinfo.h b/gst/gstinfo.h
index fb2570d..17db990 100644 (file)
--- a/gst/gstinfo.h
+++ b/gst/gstinfo.h
@@ -105,7 +105,7 @@ struct _GstDebugCategory {
 
 /********** some convenience macros for debugging **********/
 
-/* This is needed in printf's if a char* might be NULL. Solaris crashes then */
+/* This is needed in printf's if a char* might be NULL. Solaris crashes then. */
 #define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
 
 /* easier debugging for pad names */
@@ -114,8 +114,7 @@ struct _GstDebugCategory {
   GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \
   "''", GST_OBJECT_NAME (pad)
 
-/* You might want to define GST_FUNCTION in apps' configure script */
-
+/* You might want to define GST_FUNCTION in apps' configure script. */
 #ifndef GST_FUNCTION
 #if defined (__GNUC__)
 #  define GST_FUNCTION     ((const char*) (__PRETTY_FUNCTION__))

diff --git a/gst/gsttag.c b/gst/gsttag.c
index 79a7806..127a7d2 100644 (file)
--- a/gst/gsttag.c
+++ b/gst/gsttag.c
@@ -355,7 +355,7 @@ gst_tag_get_nick (const gchar * tag)
  * Returns the human-readable description of this tag, You must not change or 
  * free this string.
  *
- * Return the human-readable description of this tag
+ * Returns: the human-readable description of this tag
  */
 const gchar *
 gst_tag_get_description (const gchar * tag)

diff --git a/gst/gsttaglist.c b/gst/gsttaglist.c
index 79a7806..127a7d2 100644 (file)
--- a/gst/gsttaglist.c
+++ b/gst/gsttaglist.c
@@ -355,7 +355,7 @@ gst_tag_get_nick (const gchar * tag)
  * Returns the human-readable description of this tag, You must not change or 
  * free this string.
  *
- * Return the human-readable description of this tag
+ * Returns: the human-readable description of this tag
  */
 const gchar *
 gst_tag_get_description (const gchar * tag)

diff --git a/gst/gsttypes.h b/gst/gsttypes.h
index 836cb4a..0c091cb 100644 (file)
--- a/gst/gsttypes.h
+++ b/gst/gsttypes.h
@@ -58,10 +58,12 @@ typedef enum {
   GST_RESULT_NOT_IMPL
 } GstResult;
 
-#define GST_RANK_PRIMARY    256
-#define GST_RANK_SECONDARY  128
-#define GST_RANK_MARGINAL   64
-#define GST_RANK_NONE       0
+typedef enum {
+  GST_RANK_NONE                 = 0,
+  GST_RANK_MARGINAL             = 64,
+  GST_RANK_SECONDARY            = 128,
+  GST_RANK_PRIMARY              = 256
+} GstRank;
 
 #define GST_PADDING 4
 #define GST_PADDING_INIT       { 0 }

diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index 4efe859..a1c7525 100644 (file)
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -1974,7 +1974,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func)
 
 /* intersection */
 
-/*
+/**
  * gst_value_can_intersect:
  * @value1:
  * @value2:
@@ -2183,7 +2183,7 @@ gst_value_register_subtract_func (GType minuend_type, GType subtrahend_type,
   g_array_append_val (gst_value_subtract_funcs, info);
 }
 
-/*
+/**
  * gst_value_register:
  * @table:
  *
@@ -2194,7 +2194,7 @@ gst_value_register (const GstValueTable * table)
   g_array_append_val (gst_value_table, *table);
 }
 
-/*
+/**
  * gst_value_init_and_copy:
  * @dest:
  * @src:
@@ -2207,7 +2207,7 @@ gst_value_init_and_copy (GValue * dest, const GValue * src)
   g_value_copy (src, dest);
 }
 
-/*
+/**
  * gst_value_serialize:
  * @value: a #GValue to serialize
  *
@@ -2253,7 +2253,7 @@ gst_value_serialize (const GValue * value)
   return s;
 }
 
-/*
+/**
  * gst_value_deserialize:
  * @dest: #GValue to fill with contents of deserialization
  * @src: string to deserialize
@@ -2291,11 +2291,16 @@ gst_value_deserialize (GValue * dest, const gchar * src)
   return FALSE;
 }
 
-/*
+/**
  * gst_type_is_fixed:
- * @type:
+ * @type: the #GType to check
  *
- * Returns:
+ * Tests if the given GType, if available in a GstStructure (or any other
+ * container) will contain a "fixed" (which means: one possible value) or
+ * an "unfixed" (which means: multiple possible values, such as data lists
+ * or data ranges) value.
+ *
+ * Returns: true if the type is "fixed".
  */
 gboolean
 gst_type_is_fixed (GType type)