Small documentation updates/fixes

Original commit message from CVS:
* ext/theora/theoradec.c:
* ext/vorbis/vorbisdec.c:
* gst-libs/gst/audio/gstringbuffer.c:
(gst_ring_buffer_commit_full):
* gst-libs/gst/audio/gstringbuffer.h:
* gst-libs/gst/rtp/gstrtpbuffer.c:
* gst-libs/gst/tag/gstvorbistag.c:
Small documentation updates/fixes

diff --git a/ChangeLog b/ChangeLog
index 5300f53..3d17bb6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2007-01-09  Wim Taymans  <wim@fluendo.com>
+
+       * ext/theora/theoradec.c:
+       * ext/vorbis/vorbisdec.c:
+       * gst-libs/gst/audio/gstringbuffer.c:
+       (gst_ring_buffer_commit_full):
+       * gst-libs/gst/audio/gstringbuffer.h:
+       * gst-libs/gst/rtp/gstrtpbuffer.c:
+       * gst-libs/gst/tag/gstvorbistag.c:
+       Small documentation updates/fixes
+
 2007-01-09  Tim-Philipp Müller  <tim at centricular dot net>
 
        * configure.ac:

diff --git a/ext/theora/theoradec.c b/ext/theora/theoradec.c
index 88bd299..a1695fb 100644 (file)
--- a/ext/theora/theoradec.c
+++ b/ext/theora/theoradec.c
@@ -1269,7 +1269,7 @@ done:
  *   head of the queue.
  *
  *   Copy head of the gather queue (4) to decode queue, we flushed the gather
- *   queue an can now store input buffer in the gather queue:
+ *   queue and can now store input buffer in the gather queue:
  *
  *    gather queue:    1
  *    decode queue:    4

diff --git a/ext/vorbis/vorbisdec.c b/ext/vorbis/vorbisdec.c
index e672dda..340267f 100644 (file)
--- a/ext/vorbis/vorbisdec.c
+++ b/ext/vorbis/vorbisdec.c
@@ -1155,7 +1155,7 @@ wrong_size:
  *    output queue:    
  *
  * When a DISCONT is received (buffer 4), we move the gather queue to the 
- * decode queue. This simply done be taking the head of the gather queue
+ * decode queue. This is simply done be taking the head of the gather queue
  * and prepending it to the decode queue. This yields:
  * 
  *    gather queue:    
@@ -1169,7 +1169,7 @@ wrong_size:
  *
  *    gather queue:    
  *    decode queue:    7  8  9
- *    output queue:    8  9
+ *    output queue:    9  8
  *
  * Then we remove the consumed buffers from the decode queue. Buffer 7 is not
  * completely consumed, we need to keep it around for when we receive buffer 

diff --git a/gst-libs/gst/audio/gstringbuffer.c b/gst-libs/gst/audio/gstringbuffer.c
index 5771241..ed9f514 100644 (file)
--- a/gst-libs/gst/audio/gstringbuffer.c
+++ b/gst-libs/gst/audio/gstringbuffer.c
@@ -20,7 +20,7 @@
 /**
  * SECTION:gstringbuffer
  * @short_description: Base class for audio ringbuffer implementations
- * @see_also: gstbaseaudiosink
+ * @see_also: #GstBaseAudioSink, #GstAudioSink
  *
  * <refsect2>
  * <para>
@@ -1267,23 +1267,29 @@ G_STMT_START {                                  \
  * @sample: the sample position of the data
  * @data: the data to commit
  * @in_samples: the number of samples in the data to commit
- * @out_sampled: the number of samples to write to the ringbuffer
+ * @out_samples: the number of samples to write to the ringbuffer
  * @accum: accumulator for rate conversion.
  *
- * Commit @len samples pointed to by @data to the ringbuffer @buf. 
+ * Commit @in_samples samples pointed to by @data to the ringbuffer @buf. 
  *
- * @num and @denom define the rate conversion to perform on the the samples in
- * @data. For negative rates, @num must be negative and @denom positive.
+ * @in_samples and @out_samples define the rate conversion to perform on the the
+ * samples in @data. For negative rates, @out_samples must be negative and
+ * @in_samples positive.
  *
- * When @num is positive, the first sample will be written at position @sample
- * in the ringbuffer. When @num is negative, the last sample will be written to
+ * When @out_samples is positive, the first sample will be written at position @sample
+ * in the ringbuffer. When @out_samples is negative, the last sample will be written to
  * @sample in reverse order.
  *
- * @len does not need to be a multiple of the segment size of the ringbuffer (if
- * @num and @denom are both 1) although it is recommended for optimal performance. 
+ * @out_samples does not need to be a multiple of the segment size of the ringbuffer
+ * although it is recommended for optimal performance. 
+ *
+ * @accum will hold a temporary accumulator used in rate conversion and should be
+ * set to 0 when this function is first called. In case the commit operation is
+ * interrupted, one can resume the processing by passing the previously returned
+ * @accum value back to this function.
  *
  * Returns: The number of samples written to the ringbuffer or -1 on error. The
- * number of samples written can be less than @len when @buf was interrupted
+ * number of samples written can be less than @out_samples when @buf was interrupted
  * with a flush or stop.
  *
  * Since: 0.10.11.
@@ -1430,8 +1436,8 @@ not_started:
  * @data: the data to commit
  * @len: the number of samples in the data to commit
  *
- * Same as gst_ring_buffer_commit_full() but with a num, denom of 1, ignoring
- * accum.
+ * Same as gst_ring_buffer_commit_full() but with a in_samples and out_samples
+ * equal to @len, ignoring accum.
  *
  * Returns: The number of samples written to the ringbuffer or -1 on
  * error.

diff --git a/gst-libs/gst/audio/gstringbuffer.h b/gst-libs/gst/audio/gstringbuffer.h
index 5f8018d..3ead78f 100644 (file)
--- a/gst-libs/gst/audio/gstringbuffer.h
+++ b/gst-libs/gst/audio/gstringbuffer.h
@@ -193,7 +193,7 @@ struct _GstRingBufferSpec
   
   guint64  latency_time;        /* the required/actual latency time */
   guint64  buffer_time;         /* the required/actual time of the buffer */
-  gint     segsize;             /* size of one buffer segement */
+  gint     segsize;             /* size of one buffer segment in bytes */
   gint     segtotal;            /* total number of segments */
 
   /* out */

diff --git a/gst-libs/gst/rtp/gstrtpbuffer.c b/gst-libs/gst/rtp/gstrtpbuffer.c
index 1e04aaf..a8e9c48 100644 (file)
--- a/gst-libs/gst/rtp/gstrtpbuffer.c
+++ b/gst-libs/gst/rtp/gstrtpbuffer.c
@@ -795,7 +795,7 @@ gst_rtp_buffer_get_payload_subbuffer (GstBuffer * buffer, guint offset,
  * @buffer: the buffer
  *
  * Create a buffer of the payload of the RTP packet in @buffer. This function
- * will internally create a subbuffer of @buffer so that a memcopy can be
+ * will internally create a subbuffer of @buffer so that a memcpy can be
  * avoided.
  *
  * Returns: A new buffer with the data of the payload.
@@ -836,7 +836,7 @@ gst_rtp_buffer_get_payload_len (GstBuffer * buffer)
  * @buffer: the buffer
  *
  * Get a pointer to the payload data in @buffer. This pointer is valid as long
- * as a reference to @buffer is helt.
+ * as a reference to @buffer is held.
  *
  * Returns: A pointer to the payload data in @buffer.
  */

diff --git a/gst-libs/gst/tag/gstvorbistag.c b/gst-libs/gst/tag/gstvorbistag.c
index 5b6a71a..849af55 100644 (file)
--- a/gst-libs/gst/tag/gstvorbistag.c
+++ b/gst-libs/gst/tag/gstvorbistag.c
@@ -81,7 +81,7 @@ static const GstTagEntryMatch tag_matches[] = {
  * gst_tag_from_vorbis_tag:
  * @vorbis_tag: vorbiscomment tag to convert to GStreamer tag
  *
- * Looks up the GStreamer tag for a vorbiscommment tag.
+ * Looks up the GStreamer tag for a vorbiscomment tag.
  *
  * Returns: The corresponding GStreamer tag or NULL if none exists.
  */
@@ -110,9 +110,9 @@ gst_tag_from_vorbis_tag (const gchar * vorbis_tag)
  * gst_tag_to_vorbis_tag:
  * @gst_tag: GStreamer tag to convert to vorbiscomment tag
  *
- * Looks up the vorbiscommment tag for a GStreamer tag.
+ * Looks up the vorbiscomment tag for a GStreamer tag.
  *
- * Returns: The corresponding vorbiscommment tag or NULL if none exists.
+ * Returns: The corresponding vorbiscomment tag or NULL if none exists.
  */
 G_CONST_RETURN gchar *
 gst_tag_to_vorbis_tag (const gchar * gst_tag)