Typo fixes; minor docs addition.
authorTim-Philipp Müller <tim@centricular.net>
Sat, 28 Apr 2007 11:29:54 +0000 (11:29 +0000)
committerTim-Philipp Müller <tim@centricular.net>
Sat, 28 Apr 2007 11:29:54 +0000 (11:29 +0000)
Original commit message from CVS:
* docs/design/part-events.txt:
* docs/design/part-overview.txt:
* gst/gstevent.c:
* gst/gsturi.c:
* gst/gsturi.h:
* libs/gst/base/gstbasesink.c:
Typo fixes; minor docs addition.

ChangeLog
docs/design/part-events.txt
docs/design/part-overview.txt
gst/gstevent.c
gst/gsturi.c
gst/gsturi.h
libs/gst/base/gstbasesink.c

index 4a8b8f5..81bfaea 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2007-04-28  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * docs/design/part-events.txt:
+       * docs/design/part-overview.txt:
+       * gst/gstevent.c:
+       * gst/gsturi.c:
+       * gst/gsturi.h:
+       * libs/gst/base/gstbasesink.c:
+         Typo fixes; minor docs addition.
+
 2007-04-27  Sebastian Dröge  <slomo@circular-chaos.org>
 
        * docs/gst/gstreamer-sections.txt:
index ad2672d..0b5d2c0 100644 (file)
@@ -217,7 +217,7 @@ The general flow of executing the seek with FLUSH is as follows:
  4) send a FLUSH_STOP event to all peer elements to allow streaming again.
 
  5) create a NEWSEGMENT event to signal the new buffer timestamp base time.
-    This event must be queued to be send by the streaming thread.
+    This event must be queued to be sent by the streaming thread.
 
  6) start stopped tasks and unlock the STREAM_LOCK, dataflow will continue
     now from the new position.
index 0a3cf47..36c2269 100644 (file)
@@ -216,8 +216,8 @@ Dataflow and buffers
  automatically and will call the gst_pad_set_caps() function of the element before
  sending the buffer to the element.
 
- Both gst_pad_push() and gst_pad_pull_range() have a return value indicating wether
- the operation succeeded. An error code means that no more data should be send
+ Both gst_pad_push() and gst_pad_pull_range() have a return value indicating whether
+ the operation succeeded. An error code means that no more data should be sent
  to that pad. A source element that initiates the data flow in a thread typically
  pauses the producing thread when this happens.
  
index de94c81..2953c18 100644 (file)
@@ -351,14 +351,14 @@ gst_event_get_structure (GstEvent * event)
 /**
  * gst_event_new_flush_start:
  *
- * Allocate a new flush start event. The flush start event can be send
+ * Allocate a new flush start event. The flush start event can be sent
  * upstream and downstream and travels out-of-bounds with the dataflow.
  *
  * It marks pads as being flushing and will make them return
  * #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
  * gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
  * gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
- * on a flushing pad will return %FALSE immediatly.
+ * on a flushing pad will return %FALSE immediately.
  *
  * Elements should unlock any blocking functions and exit their streaming
  * functions as fast as possible when this event is received.
@@ -377,9 +377,9 @@ gst_event_new_flush_start (void)
 /**
  * gst_event_new_flush_stop:
  *
- * Allocate a new flush stop event. The flush start event can be send
+ * Allocate a new flush stop event. The flush stop event can be sent
  * upstream and downstream and travels out-of-bounds with the dataflow.
- * It is typically send after sending a FLUSH_START event to make the
+ * It is typically sent after sending a FLUSH_START event to make the
  * pads accept data again.
  *
  * Elements can process this event synchronized with the dataflow since
index 85e7cac..eb3cfed 100644 (file)
@@ -521,10 +521,12 @@ get_element_factories_from_uri_protocol (const GstURIType type,
 
 /**
  * gst_uri_protocol_is_supported:
- * @type: Wether to check for a source or a sink
- * @protocol: Protocol that should be checkd for.
+ * @type: Whether to check for a source or a sink
+ * @protocol: Protocol that should be checked for (e.g. "http" or "smb")
  *
- * Checks if an element exists that supports the given URI protocol.
+ * Checks if an element exists that supports the given URI protocol. Note
+ * that a positive return value does not imply that a subsequent call to
+ * gst_element_make_from_uri() is guaranteed to work.
  *
  * Returns: TRUE
  *
@@ -548,7 +550,7 @@ gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol)
 
 /**
  * gst_element_make_from_uri:
- * @type: Wether to create a source or a sink
+ * @type: Whether to create a source or a sink
  * @uri: URI to create an element for
  * @elementname: Name of created element, can be NULL.
  *
index a3256a5..899bdad 100644 (file)
@@ -71,7 +71,7 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
 /**
  * GstURIHandlerInterface:
  * @parent: The parent interface type
- * @get_type: Method to tell wether the element handles source or sink URI.
+ * @get_type: Method to tell whether the element handles source or sink URI.
  * @get_protocols: Method to return the list of protocols handled by the element.
  * @get_uri: Method to return the URI currently handled by the element.
  * @set_uri: Method to set a new URI.
index 34e9357..80023dd 100644 (file)
  * The qos property will enable the quality-of-service features of the basesink
  * which gather statistics about the real-time performance of the clock
  * synchronisation. For each buffer received in the sink, statistics are
- * gathered and a QOS event is send upstream with these numbers. This
+ * gathered and a QOS event is sent upstream with these numbers. This
  * information can then be used by upstream elements to reduce their processing
  * rate, for example.
  *