Documentation updates

Original commit message from CVS:
Documentation updates

diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 8a98d92..2c234eb 100644 (file)
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -24,6 +24,7 @@
 <!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
 <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
 <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
+<!entity GstQuery SYSTEM "sgml/gstquery.sgml">
 <!entity GstThread SYSTEM "sgml/gstthread.sgml">
 <!entity GstRegistry SYSTEM "sgml/gstregistry.sgml">
 <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
@@ -109,6 +110,7 @@ with some more specialized elements.</para>
     &GstProbe;
     &GstProps;
     &GstQueue;
+    &GstQuery;
     &GstRegistry;
     &GstScheduler;
     &GstSchedulerFactory;

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index a1858af..409a681 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -40,19 +40,12 @@ GST_ATOMIC_INT_READ
 GST_ATOMIC_INT_INC
 GST_ATOMIC_INT_DEC_AND_TEST
 GST_ATOMIC_INT_ADD
-GstAtomicSwap
-GST_ATOMIC_SWAP_VALUE
-GST_ATOMIC_SWAP_INIT
-GST_ATOMIC_SWAP
-GST_ATOMIC_SWAP_GET
 <SUBSECTION Standard>
-GST_ATOMIC_LOCK
 </SECTION>
 
 <SECTION>
 <FILE>gstmemchunk</FILE>
 GstMemChunk
-GstMemChunkElement
 gst_mem_chunk_new
 gst_mem_chunk_destroy
 gst_mem_chunk_alloc
@@ -815,6 +808,12 @@ gst_object_flags_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gstquery</FILE>
+GstQueryType
+GST_QUERY_TYPE_FUNCTION
+</SECTION>
+
+<SECTION>
 <FILE>gstpad</FILE>
 <TITLE>GstPad</TITLE>
 GST_PAD_NAME
@@ -845,12 +844,13 @@ GstPadConvertFunction
 GstPadDispatcherFunction
 GstPadIntConnFunction
 
-GstPadQueryType
 GstPadQueryFunction
 GstPadEventMaskFunction
 GstPadFormatsFunction
 GstPadQueryTypeFunction
 GST_PAD_QUERY_TYPE_FUNCTION
+GST_PAD_FORMATS_FUNCTION
+GST_PAD_EVENT_MASK_FUNCTION
 
 GstPadDirection
 GstPadFlags
@@ -908,7 +908,6 @@ gst_pad_event_default
 gst_pad_set_event_function
 gst_pad_get_event_masks
 gst_pad_get_event_masks_default
-gst_pad_handles_event
 gst_pad_set_event_mask_function
 
 gst_pad_set_convert_function
@@ -916,7 +915,6 @@ gst_pad_convert
 gst_pad_convert_default
 gst_pad_get_formats
 gst_pad_get_formats_default
-gst_pad_handles_format
 gst_pad_set_formats_function
 
 gst_pad_get_internal_connections
@@ -1005,8 +1003,6 @@ GST_TYPE_PAD_FLAGS
 gst_pad_flags_get_type
 GST_TYPE_PAD_PRESENCE
 gst_pad_presence_get_type
-GST_TYPE_PAD_QUERY_TYPE
-gst_pad_query_type_get_type
 </SECTION>
 
 <SECTION>

diff --git a/docs/gst/tmpl/gstatomic.sgml b/docs/gst/tmpl/gstatomic.sgml
index a863c08..6ffe92d 100644 (file)
--- a/docs/gst/tmpl/gstatomic.sgml
+++ b/docs/gst/tmpl/gstatomic.sgml
@@ -93,47 +93,3 @@ Atomically add a value to a #GstAtomicInt
 @count: The value to add
 
 
-<!-- ##### STRUCT GstAtomicSwap ##### -->
-<para>
-The structure to handle values that can be swapped atomically
-</para>
-
-@lock: 
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
-<para>
-Get the value of a #GstAtomicSwap
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
-<para>
-Initialize an atomic swap structure
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the initial value
-
-
-<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
-<para>
-Atomically swap the value of the #GstAtomicSwap with a new value
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the new value
-
-
-<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
-<para>
-Atomically swap the value of the #GstAtomicSwap with a new value and
-get the old value.
-</para>
-
-@swap: a reference to a #GstAtomicSwap
-@val: the new value
-@res: the old value
-
-

diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml
index e488a10..ce9ce23 100644 (file)
--- a/docs/gst/tmpl/gstclock.sgml
+++ b/docs/gst/tmpl/gstclock.sgml
@@ -395,6 +395,11 @@ The GstClock object
 @id: 
 
 
+<!-- ##### ARG GstClock:max-diff ##### -->
+<para>
+Maximum allowed diff for clock sync requests against the real time.
+</para>
+
 <!-- ##### ARG GstClock:stats ##### -->
 <para>
 Boolean property to activate stat generation on the clock.

diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml
index 12b5388..49f4ff9 100644 (file)
--- a/docs/gst/tmpl/gstelement.sgml
+++ b/docs/gst/tmpl/gstelement.sgml
@@ -457,10 +457,12 @@ Sets the name of the element, getting rid of the old name if there was one.
 </para>
 
 @element: 
-@clock: 
-@time: 
+@id: 
 @jitter: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@clock: 
+@time: 
 
 
 <!-- ##### FUNCTION gst_element_provides_clock ##### -->

diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml
index 4d90997..3c53002 100644 (file)
--- a/docs/gst/tmpl/gstevent.sgml
+++ b/docs/gst/tmpl/gstevent.sgml
@@ -382,6 +382,7 @@ Create a new flush event.
 A convenience macro to create event mask functions
 </para>
 
+@type: 
 @functionname: the name of the function
 @...: event masks, the last element is marked with 0
 

diff --git a/docs/gst/tmpl/gstformat.sgml b/docs/gst/tmpl/gstformat.sgml
index bbfcf68..597073a 100644 (file)
--- a/docs/gst/tmpl/gstformat.sgml
+++ b/docs/gst/tmpl/gstformat.sgml
@@ -44,6 +44,7 @@ A convenience function to define a function that returns an array
 of formats.
 </para>
 
+@type: The type of the first argument of the function
 @functionname: The name of the function
 @...: comma separated list of functions closed with 0
 

diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml
index 917c938..b56909a 100644 (file)
--- a/docs/gst/tmpl/gstindex.sgml
+++ b/docs/gst/tmpl/gstindex.sgml
@@ -110,6 +110,7 @@ flags for an association entry
 
 @GST_ACCOCIATION_FLAG_NONE: no flags
 @GST_ACCOCIATION_FLAG_KEY_UNIT: this entry marks a key unit.
+@GST_ACCOCIATION_FLAG_LAST: 
 
 <!-- ##### MACRO GST_INDEX_FORMAT_FORMAT ##### -->
 <para>
@@ -307,6 +308,7 @@ The GstIndex object
 @index: 
 @id: 
 @method: 
+@flags: 
 @format: 
 @value: 
 @Returns: 
@@ -320,6 +322,7 @@ The GstIndex object
 @index: 
 @id: 
 @method: 
+@flags: 
 @format: 
 @value: 
 @func: 

diff --git a/docs/gst/tmpl/gstmemchunk.sgml b/docs/gst/tmpl/gstmemchunk.sgml
index e220c35..1d3bd10 100644 (file)
--- a/docs/gst/tmpl/gstmemchunk.sgml
+++ b/docs/gst/tmpl/gstmemchunk.sgml
@@ -26,21 +26,6 @@ The GstMemChunk is used to allocate critical resources for #GstBuffer and
 The memchunk structure
 </para>
 
-@swap: 
-@name: 
-@area_size: 
-@chunk_size: 
-@atom_size: 
-@cleanup: 
-@lock: 
-
-<!-- ##### STRUCT GstMemChunkElement ##### -->
-<para>
-An entry in the memchunk area
-</para>
-
-@link: 
-@area: 
 
 <!-- ##### FUNCTION gst_mem_chunk_new ##### -->
 <para>

diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index 698a74c..6125607 100644 (file)
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -291,22 +291,6 @@ The signature of the internal pad connection function.
           The caller must call g_list_free() on it after use.
 
 
-<!-- ##### ENUM GstPadQueryType ##### -->
-<para>
-The different supported query types.
-</para>
-
-@GST_PAD_QUERY_NONE: 
-@GST_PAD_QUERY_TOTAL: Query the total stream time.
-@GST_PAD_QUERY_POSITION: Query the current stream position.
-@GST_PAD_QUERY_LATENCY: Query the latency on the pad.
-@GST_PAD_QUERY_JITTER: Query the average jitter beteen optimal processing 
-                       and current processing.
-@GST_PAD_QUERY_START: Query for the configured start time for segmented seek
-@GST_PAD_QUERY_SEGMENT_END: Query the end position of the currently 
-                            executing segment.
-@GST_PAD_QUERY_RATE: Query at which rate this pad will process data.
-
 <!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
 <para>
 The signature of the query function.
@@ -355,6 +339,26 @@ A convenience macro to construct query type functions
 @...: query types, 0 to mark the last element
 
 
+<!-- ##### MACRO GST_PAD_FORMATS_FUNCTION ##### -->
+<para>
+Convenience function to define an array of formats that can be used
+as #GstPadGetFormatsFunction.
+</para>
+
+@functionname: The name of the function
+@...: comma separated list of formats, 0 to mark the end
+
+
+<!-- ##### MACRO GST_PAD_EVENT_MASK_FUNCTION ##### -->
+<para>
+Convenience function to define an array of event masks that can be used
+as #GstPadGetEventMaskFunction.
+</para>
+
+@functionname: The name of the function
+@...: comma separated list of event maks, { 0, } to mark the end
+
+
 <!-- ##### ENUM GstPadDirection ##### -->
 <para>
 The direction of a pad.
@@ -857,16 +861,6 @@ Destroy the pad.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_pad_handles_event ##### -->
-<para>
-
-</para>
-
-@pad: 
-@mask: 
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_pad_set_event_mask_function ##### -->
 <para>
 
@@ -929,16 +923,6 @@ Destroy the pad.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_pad_handles_format ##### -->
-<para>
-
-</para>
-
-@pad: 
-@format: 
-@Returns: 
-
-
 <!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml
index 53a9dec..fe9d9df 100644 (file)
--- a/docs/gst/tmpl/gstreamer-unused.sgml
+++ b/docs/gst/tmpl/gstreamer-unused.sgml
@@ -1449,6 +1449,39 @@ g_print messages.
 </para>
 
 
+<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
+<para>
+Atomically swap the value of the #GstAtomicSwap with a new value
+</para>
+
+@swap: a reference to a #GstAtomicSwap
+@val: the new value
+
+<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
+<para>
+Atomically swap the value of the #GstAtomicSwap with a new value and
+get the old value.
+</para>
+
+@swap: a reference to a #GstAtomicSwap
+@val: the new value
+@res: the old value
+
+<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
+<para>
+Initialize an atomic swap structure
+</para>
+
+@swap: a reference to a #GstAtomicSwap
+@val: the initial value
+
+<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
+<para>
+Get the value of a #GstAtomicSwap
+</para>
+
+@swap: a reference to a #GstAtomicSwap
+
 <!-- ##### MACRO GST_AUDIOSINK ##### -->
 <para>
 
@@ -4027,6 +4060,13 @@ Specify the current offset in the file.
 @GST_ASYNCDISKSRC_OPEN: 
 @GST_ASYNCDISKSRC_FLAG_LAST: 
 
+<!-- ##### STRUCT GstAtomicSwap ##### -->
+<para>
+The structure to handle values that can be swapped atomically
+</para>
+
+@lock: 
+
 <!-- ##### STRUCT GstAudioSink ##### -->
 <para>
 
@@ -4909,6 +4949,14 @@ Specify the location of the file. The location must be a fully qualified URL.
 </para>
 
 
+<!-- ##### STRUCT GstMemChunkElement ##### -->
+<para>
+An entry in the memchunk area
+</para>
+
+@link: 
+@area: 
+
 <!-- ##### STRUCT GstMeta ##### -->
 <para>
 
@@ -5063,6 +5111,22 @@ The function that will be called when a QoS message is sent.
 @pad: the pad that sent the QoS message
 @qos_message: the message
 
+<!-- ##### ENUM GstPadQueryType ##### -->
+<para>
+The different supported query types.
+</para>
+
+@GST_PAD_QUERY_NONE: 
+@GST_PAD_QUERY_TOTAL: Query the total stream time.
+@GST_PAD_QUERY_POSITION: Query the current stream position.
+@GST_PAD_QUERY_LATENCY: Query the latency on the pad.
+@GST_PAD_QUERY_JITTER: Query the average jitter beteen optimal processing 
+                       and current processing.
+@GST_PAD_QUERY_START: Query for the configured start time for segmented seek
+@GST_PAD_QUERY_SEGMENT_END: Query the end position of the currently 
+                            executing segment.
+@GST_PAD_QUERY_RATE: Query at which rate this pad will process data.
+
 <!-- ##### STRUCT GstPadTemplateClass ##### -->
 <para>
 
@@ -8576,6 +8640,24 @@ Call the EOS function of the pad
 @pad: 
 @qos_message: 
 
+<!-- ##### FUNCTION gst_pad_handles_event ##### -->
+<para>
+
+</para>
+
+@pad: 
+@mask: 
+@Returns: 
+
+<!-- ##### FUNCTION gst_pad_handles_format ##### -->
+<para>
+
+</para>
+
+@pad: 
+@format: 
+@Returns: 
+
 <!-- ##### FUNCTION gst_pad_negotiate_proxy ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml
index d6cd8d8..4193645 100644 (file)
--- a/docs/gst/tmpl/gstscheduler.sgml
+++ b/docs/gst/tmpl/gstscheduler.sgml
@@ -247,10 +247,12 @@ Destroy the scheduler
 
 @sched: 
 @element: 
-@clock: 
-@time: 
+@id: 
 @jitter: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@clock: 
+@time: 
 
 
 <!-- ##### FUNCTION gst_scheduler_iterate ##### -->

diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml
index 08450b2..32d00bc 100644 (file)
--- a/docs/gst/tmpl/gstxml.sgml
+++ b/docs/gst/tmpl/gstxml.sgml
@@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
 
 </para>
 
-@: 
-@: 
-@:
-
 @gstxml: the object which received the signal.
 @arg1: 
 @arg2: 
@@ -123,7 +119,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
 
 </para>
 
-@gstxml: the object which received the signal.
-@arg1: 
-@arg2: 
+@: 
+@: 
+@: