Small documentation fixes.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstbuffer.h:
* gst/gstvalue.c:
* libs/gst/base/gstbasetransform.h:
Small documentation fixes.

diff --git a/ChangeLog b/ChangeLog
index 22fa663..2a3033d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2006-03-07  Wim Taymans  <wim@fluendo.com>
+
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gstbuffer.h:
+       * gst/gstvalue.c:
+       * libs/gst/base/gstbasetransform.h:
+       Small documentation fixes.
+
 2006-03-07  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/gstvalue.c:

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 30ccb7b..1ef79a7 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -2045,7 +2045,7 @@ gst_util_gdouble_to_guint64
 
 <SECTION>
 <FILE>gstvalue</FILE>
-<TITLE>GStreamer GValue types</TITLE>
+<TITLE>GstValue</TITLE>
 
 <SUBSECTION fourcc>
 GST_VALUE_HOLDS_FOURCC

diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h
index 90ccb11..7b72515 100644 (file)
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@@ -180,10 +180,12 @@ typedef struct _GstBufferClass GstBufferClass;
 
 /**
  * GstBufferFlag:
- * @GST_BUFFER_FLAG_READONLY: the buffer is read-only.
+ * @GST_BUFFER_FLAG_READONLY: the buffer is read-only. This means the data of
+ * the buffer should not be modified. The metadata might still be modified.
  * @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
  * displayed.
- * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.
+ * @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream. This
+ * typically occurs after a seek or a dropped buffer from a live or network source.
  * @GST_BUFFER_FLAG_IN_CAPS: the buffer has been added as a field in a #GstCaps.
  * @GST_BUFFER_FLAG_GAP: the buffer has been created to fill a gap in the stream.
  * @GST_BUFFER_FLAG_DELTA_UNIT: this unit cannot be decoded independently.
@@ -252,7 +254,6 @@ struct _GstBuffer {
 
 struct _GstBufferClass {
   GstMiniObjectClass    mini_object_class;
-
 };
 
 /* allocation */

diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index d8b37f7..c77a1b2 100644 (file)
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -23,7 +23,10 @@
  *
  * GValue implementations specific to GStreamer.
  *
- * Last reviewed on 2005-11-23 (0.9.5)
+ * Note that operations on the same GstValue (or GValue) from multiple
+ * threads may lead to undefined behaviour. 
+ *
+ * Last reviewed on 2006-03-07 (0.10.4)
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h
index 63a48c6..84826f8 100644 (file)
--- a/libs/gst/base/gstbasetransform.h
+++ b/libs/gst/base/gstbasetransform.h
@@ -147,7 +147,7 @@ struct _GstBaseTransformClass {
   /* transform a buffer inplace */
   GstFlowReturn (*transform_ip) (GstBaseTransform *trans, GstBuffer *buf);
 
-  /* FIXME: When adjusting the padding, more these to nicer places in the class */
+  /* FIXME: When adjusting the padding, move these to nicer places in the class */
   /* Set by child classes to automatically do passthrough mode */
   gboolean       passthrough_on_same_caps;