Documentation updates

Original commit message from CVS:
Documentation updates

diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 2c234ebae6fb4d2fb707a35c4e2a90e8ccf803d9..66932815181fadf1a030147bd6e63e89dd4b15c0 100644 (file)
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -99,6 +99,8 @@ with some more specialized elements.</para>
     &GstElementFactory;
     &GstEvent;
     &GstFormat;
+    &GstIndex;
+    &GstIndexFactory;
     &GstInfo;
     &GstObject;
     &GstPad;
@@ -109,15 +111,13 @@ with some more specialized elements.</para>
     &GstPluginFeature;
     &GstProbe;
     &GstProps;
-    &GstQueue;
     &GstQuery;
+    &GstQueue;
     &GstRegistry;
     &GstScheduler;
     &GstSchedulerFactory;
     &GstSystemClock;
     &GstThread;
-    &GstIndex;
-    &GstIndexFactory;
     &GstType;
     &GstTypeFactory;
     &GstTypeFind;

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 409a6816079da18f43e9582a7e5208a4e689c172..13a509a6c075c042310391d4855cc51d5cc0f462 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -32,14 +32,13 @@ cothread_current
 <SECTION>
 <FILE>gstatomic</FILE>
 GstAtomicInt
-GST_ATOMIC_INT_INIT
-GST_ATOMIC_INT_FREE
-GST_ATOMIC_INT_SET
-GST_ATOMIC_INT_VALUE
-GST_ATOMIC_INT_READ
-GST_ATOMIC_INT_INC
-GST_ATOMIC_INT_DEC_AND_TEST
-GST_ATOMIC_INT_ADD
+gst_atomic_int_init
+gst_atomic_int_destroy
+gst_atomic_int_set
+gst_atomic_int_read
+gst_atomic_int_add
+gst_atomic_int_inc
+gst_atomic_int_dec_and_test
 <SUBSECTION Standard>
 </SECTION>
 
@@ -192,10 +191,13 @@ GstSchedulerFactoryClass
 <FILE>gstformat</FILE>
 <TITLE>GstFormat</TITLE>
 GstFormat
+GST_FORMAT_PERCENT_MAX
+GST_FORMAT_PERCENT_SCALE
 GstFormatDefinition
 GST_FORMATS_FUNCTION
 gst_format_register
 gst_format_get_by_nick
+gst_formats_contains
 gst_format_get_details
 gst_format_get_definitions
 <SUBSECTION Standard>
@@ -277,7 +279,6 @@ GstDataFlags
 GST_DATA_IS_READONLY
 GST_DATA_REFCOUNT
 GST_DATA_REFCOUNT_VALUE
-GST_DATA_REFCOUNT_READ
 GST_DATA_COPY_FUNC
 GST_DATA_FREE_FUNC
 gst_data_init
@@ -810,7 +811,14 @@ gst_object_flags_get_type
 <SECTION>
 <FILE>gstquery</FILE>
 GstQueryType
+GST_QUERY_TYPE_RATE_DEN
+GstQueryTypeDefinition
 GST_QUERY_TYPE_FUNCTION
+gst_query_type_register
+gst_query_type_get_by_nick
+gst_query_types_contains
+gst_query_type_get_details
+gst_query_type_get_definitions
 </SECTION>
 
 <SECTION>

diff --git a/docs/gst/tmpl/gstatomic.sgml b/docs/gst/tmpl/gstatomic.sgml
index 6ffe92d75f833ac63cfdb6527c53869fb10f583d..79380e6a99e50bd0b204a4e0550aeda6861787c2 100644 (file)
--- a/docs/gst/tmpl/gstatomic.sgml
+++ b/docs/gst/tmpl/gstatomic.sgml
@@ -2,13 +2,16 @@
 GstAtomic
 
 <!-- ##### SECTION Short_Description ##### -->
-Macros that implement atomic operations
+Functions that implement atomic operations.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-GstAtomic contains a set of macros that can be used to implement
-atomic algorithms that are thread safe and don't use heavyweight
-locking mechanisms.
+Functions that implement atomic operations on a #GstAtomicInt structure. 
+Atomic operations are thread safe and don't use heavyweight locking mechanisms.
+</para>
+<para>
+These functions will be inlined in the GStreamer core but are available to plugins
+as external methods.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -22,74 +25,68 @@ A structure that contains an integer that can be modified
 atomically.
 </para>
 
+@lock: 
 
-<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
-<para>
-Initialize an atomic int
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@val: The initial value for the integer
-
-
-<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
+<!-- ##### FUNCTION gst_atomic_int_init ##### -->
 <para>
-Free the memory allocated by #GST_ATOMIC_INT_INIT
+Initialize an allocated #GstAtomicInt with a value. Call this method
+only once as it will allocate a mutex in the C-fallback case.
 </para>
 
-@ref: A reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: a new value
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
+<!-- ##### FUNCTION gst_atomic_int_destroy ##### -->
 <para>
-Set the value of a #GstAtomicInt atomically
+Destroy a #GstAtomicInt. Call this method only once as it will
+free the mutex in the C-fallback case.
 </para>
 
-@ref: a reference to a #GstAtomicInt
-@val: The value for the integer
+@aint: a #GstAtomicInt
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
+<!-- ##### FUNCTION gst_atomic_int_set ##### -->
 <para>
-Get the value of a #GstAtomicInt atomically
+Atomically set the value on the #GstAtomicInt.
 </para>
 
-@ref: a reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: The new value
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
+<!-- ##### FUNCTION gst_atomic_int_read ##### -->
 <para>
-Get the value of a #GstAtomicInt atomically into a variable
+Atomically read the contents of a #GstAtomicInt
 </para>
 
-@ref: a reference to a #GstAtomicInt
-@res: a pointer to a gint to hold the value
+@aint: a #GstAtomicInt
+@Returns: the value of the atomic int
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
+<!-- ##### FUNCTION gst_atomic_int_add ##### -->
 <para>
-Increment the value of a #GstAtomicInt atomically
+Atomically add the given value to the #GstAtomicInt.
 </para>
 
-@ref: a reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: the value to add
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
+<!-- ##### FUNCTION gst_atomic_int_inc ##### -->
 <para>
-Decrement the value of a #GstAtomicInt atomically and test
-for zero.
+Atomically increment the #GstAtomicInt
 </para>
 
-@ref: a reference to a #GstAtomicInt
-@zero: a gpointer to a gboolean to hold the value of the test
+@aint: a #GstAtomicInt
 
 
-<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
+<!-- ##### FUNCTION gst_atomic_int_dec_and_test ##### -->
 <para>
-Atomically add a value to a #GstAtomicInt
+Atomically decrement the #GstAtomicInt and test if it is zero.
 </para>
 
-@ref: a reference to a #GstAtomicInt
-@count: The value to add
+@aint: a #GstAtomicInt
+@Returns: TRUE if the atomic int is 0
 
 

diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index 38a41423a885a0681beea42033e277db1306ca97..b6eda534c43aa0c5548e561749c81671548b6ca0 100644 (file)
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -34,7 +34,10 @@ After the bin has been set to the PLAYING state (with gst_element_set_state()),
 gst_bin_iterate() is used to process the elements in the bin.
 </para>
 <para>
-The "object_added" signal is fired whenever a new object is added to the bin.
+The "element_added" signal is fired whenever a new element is added to the bin.
+</para>
+<para>
+The "element_removed" signal is fired whenever an element is removed from the bin.
 </para>
 <para>
 gst_bin_destroy() is used to destroy the bin. 
@@ -225,7 +228,7 @@ Free the memory allocated by this bin
 </para>
 
 @gstbin: the object which received the signal.
-@arg1: 
+@arg1: the element that was added to the bin
 
 <!-- ##### SIGNAL GstBin::element-removed ##### -->
 <para>
@@ -233,5 +236,5 @@ Free the memory allocated by this bin
 </para>
 
 @gstbin: the object which received the signal.
-@arg1: 
+@arg1: the element that was removed from the bin
 

diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml
index 77907142547ed27e0e2820c2bf4bad037ac04ad8..a2570a2626130824e81c72c8906301945650f460 100644 (file)
--- a/docs/gst/tmpl/gstdata.sgml
+++ b/docs/gst/tmpl/gstdata.sgml
@@ -137,15 +137,6 @@ Get the current refcount value
 @data: The GstData to query
 
 
-<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
-<para>
-Read the current refcount value into the specified value
-</para>
-
-@data: The GstData to get the refcount value of
-@value: A pointer to a gint to hold the refcount value
-
-
 <!-- ##### MACRO GST_DATA_COPY_FUNC ##### -->
 <para>
 Get access to the copy function of the data

diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml
index 3c530027f11c22ea54880a9ab1c38bafc5ea7690..bdc07382c0e0e6b30850cb402d1d320382f3a3d7 100644 (file)
--- a/docs/gst/tmpl/gstevent.sgml
+++ b/docs/gst/tmpl/gstevent.sgml
@@ -382,7 +382,7 @@ Create a new flush event.
 A convenience macro to create event mask functions
 </para>
 
-@type: 
+@type: The type of the first argument of the function
 @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 597073a5a19b0a1015fb37eb5be71393c42e6490..3d7c6d9d05b114fcf745ba54729e5ed801d771ec 100644 (file)
--- a/docs/gst/tmpl/gstformat.sgml
+++ b/docs/gst/tmpl/gstformat.sgml
@@ -12,7 +12,7 @@ formats can be used to perform seeking or conversions/query operations.
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GstPad, #GstElement
 </para>
 
 <!-- ##### ENUM GstFormat ##### -->
@@ -29,6 +29,21 @@ Standard predefined formats
 @GST_FORMAT_UNITS: frames for video, samples for audio, other definitions as 
                    defined by the media type.
 
+<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
+<para>
+The PERCENT format is between 0 and this value
+</para>
+
+
+
+<!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
+<para>
+The value used to scale down the reported PERCENT format value to
+its real value.
+</para>
+
+
+
 <!-- ##### STRUCT GstFormatDefinition ##### -->
 <para>
 A format definition
@@ -68,6 +83,16 @@ of formats.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_formats_contains ##### -->
+<para>
+
+</para>
+
+@formats: 
+@format: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_format_get_details ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml
index b56909a798e1d403c8d2599f3c9c05fbbf23f2fe..549f4a80ca65970a868da702de254ae2484e8364 100644 (file)
--- a/docs/gst/tmpl/gstindex.sgml
+++ b/docs/gst/tmpl/gstindex.sgml
@@ -12,7 +12,7 @@ in a pipeline.
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GstIndexFactory
 </para>
 
 <!-- ##### STRUCT GstIndexEntry ##### -->
@@ -108,9 +108,10 @@ An association in an entry.
 flags for an association entry
 </para>
 
-@GST_ACCOCIATION_FLAG_NONE: no flags
-@GST_ACCOCIATION_FLAG_KEY_UNIT: this entry marks a key unit.
-@GST_ACCOCIATION_FLAG_LAST: 
+@GST_ASSOCIATION_FLAG_NONE: no extra flags
+@GST_ASSOCIATION_FLAG_KEY_UNIT: the entry marks a key unit, a key unit is one
+                                that marks a place where one can randomly seek to.
+@GST_ASSOCIATION_FLAG_LAST: extra user defined flags should start here.
 
 <!-- ##### MACRO GST_INDEX_FORMAT_FORMAT ##### -->
 <para>

diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index 61256074fc0390bd82c7154ae0b804144377e445..a94945edb06d2206cc1a2360b9bf66ba6084580b 100644 (file)
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -374,7 +374,7 @@ Flags for the pad.
 </para>
 
 @GST_PAD_DISABLED: the pad is disabled.
-@GST_PAD_EOS: the pad is in end of stream state.
+@GST_PAD_NEGOTIATING: 
 @GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
 
 <!-- ##### FUNCTION gst_pad_new ##### -->

diff --git a/docs/gst/tmpl/gstquery.sgml b/docs/gst/tmpl/gstquery.sgml
index 9464f06294e73e422a56b9ab85c5528d761f444b..07925836c5a06c34f3c0e46de97c638ab5b24201 100644 (file)
--- a/docs/gst/tmpl/gstquery.sgml
+++ b/docs/gst/tmpl/gstquery.sgml
@@ -20,14 +20,30 @@ Query types can be used to perform queries on pads and elements.
 Standard predefined Query types
 </para>
 
-@GST_QUERY_NONE: 
-@GST_QUERY_TOTAL: 
-@GST_QUERY_POSITION: 
-@GST_QUERY_LATENCY: 
-@GST_QUERY_JITTER: 
-@GST_QUERY_START: 
-@GST_QUERY_SEGMENT_END: 
-@GST_QUERY_RATE: 
+@GST_QUERY_NONE: invalid query type
+@GST_QUERY_TOTAL: total length of stream
+@GST_QUERY_POSITION: current position in stream
+@GST_QUERY_LATENCY: latency of stream
+@GST_QUERY_JITTER: current jitter of stream
+@GST_QUERY_START: start of configured segment
+@GST_QUERY_SEGMENT_END: end of configured segment
+@GST_QUERY_RATE: current rate of the stream
+
+<!-- ##### MACRO GST_QUERY_TYPE_RATE_DEN ##### -->
+<para>
+Rates are relative to this value
+</para>
+
+
+
+<!-- ##### STRUCT GstQueryTypeDefinition ##### -->
+<para>
+A Query Type definition
+</para>
+
+@value: the unique id of the Query type
+@nick: a short nick
+@description: a longer description of the query type
 
 <!-- ##### MACRO GST_QUERY_TYPE_FUNCTION ##### -->
 <para>
@@ -39,3 +55,49 @@ Convenience function to define a function that returns an array of query types.
 @...: query types, 0 to end the list
 
 
+<!-- ##### FUNCTION gst_query_type_register ##### -->
+<para>
+
+</para>
+
+@nick: 
+@description: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_query_type_get_by_nick ##### -->
+<para>
+
+</para>
+
+@nick: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_query_types_contains ##### -->
+<para>
+
+</para>
+
+@types: 
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_query_type_get_details ##### -->
+<para>
+
+</para>
+
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_query_type_get_definitions ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+

diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml
index fe9d9dfff1ab7df31ea1cc2a5b22aca443ce6898..410201ba5d4e0a3b165c0ead563738100d4e79d5 100644 (file)
--- a/docs/gst/tmpl/gstreamer-unused.sgml
+++ b/docs/gst/tmpl/gstreamer-unused.sgml
@@ -1443,6 +1443,68 @@ g_print messages.
 
 @klass: 
 
+<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
+<para>
+Atomically add a value to a #GstAtomicInt
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@count: The value to add
+
+<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
+<para>
+Decrement the value of a #GstAtomicInt atomically and test
+for zero.
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@zero: a gpointer to a gboolean to hold the value of the test
+
+<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
+<para>
+Free the memory allocated by #GST_ATOMIC_INT_INIT
+</para>
+
+@ref: A reference to a #GstAtomicInt
+
+<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
+<para>
+Increment the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+
+<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
+<para>
+Initialize an atomic int
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@val: The initial value for the integer
+
+<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
+<para>
+Get the value of a #GstAtomicInt atomically into a variable
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@res: a pointer to a gint to hold the value
+
+<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
+<para>
+Set the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@val: The value for the integer
+
+<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
+<para>
+Get the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+
 <!-- ##### MACRO GST_ATOMIC_LOCK ##### -->
 <para>
 
@@ -1735,6 +1797,14 @@ A flag indicating that SSE instructions are supported.
 </para>
 
 
+<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
+<para>
+Read the current refcount value into the specified value
+</para>
+
+@data: The GstData to get the refcount value of
+@value: A pointer to a gint to hold the refcount value
+
 <!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
 <para>
 

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

diff --git a/gst/gstquery.c b/gst/gstquery.c
index 64c3bf16f9aa902646932d93c0f69c35aa71a3ef..ca8497bbf6db2d7ca5fd688dfa33dbde4497377f 100644 (file)
--- a/gst/gstquery.c
+++ b/gst/gstquery.c
@@ -124,25 +124,25 @@ gst_query_type_get_by_nick (const gchar *nick)
 }
 
 /**
- * gst_queries_contains:
- * @queries: The query array to search
- * @query: the query to find
+ * gst_query_types_contains:
+ * @types: The query array to search
+ * @type: the querytype to find
  *
  * See if the given query is inside the query array.
  *
  * Returns: TRUE if the query is found inside the array
  */
 gboolean
-gst_queries_contains (const GstQueryType *queries, GstQueryType query)
+gst_query_types_contains (const GstQueryType *types, GstQueryType type)
 {
-  if (!queries)
+  if (!types)
     return FALSE;
 
-  while (*queries) {
-    if (*queries == query)
+  while (*types) {
+    if (*types == type)
       return TRUE;
 
-    queries++;
+    types++;
   }
   return FALSE;
 }
@@ -150,16 +150,16 @@ gst_queries_contains (const GstQueryType *queries, GstQueryType query)
 
 /**
  * gst_query_type_get_details:
- * @query: The query to get details of
+ * @type: The query to get details of
  *
  * Get details about the given query.
  *
  * Returns: The #GstQueryTypeDefinition for @query or NULL on failure.
  */
 const GstQueryTypeDefinition*
-gst_query_type_get_details (GstQueryType query)
+gst_query_type_get_details (GstQueryType type)
 {
-  return g_hash_table_lookup (_query_type_to_nick, GINT_TO_POINTER (query));
+  return g_hash_table_lookup (_query_type_to_nick, GINT_TO_POINTER (type));
 }
 
 /**