Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(22)

Unified Diff: sdk/lib/async/stream.dart

Issue 12330074: Fix some dart:io documentation comments. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | sdk/lib/io/http.dart » ('j') | sdk/lib/io/process.dart » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/async/stream.dart
diff --git a/sdk/lib/async/stream.dart b/sdk/lib/async/stream.dart
index a026484e214758b66f11b97c3de55af19a00ca49..dddc00406cc5ba3a970226010fdd988f5cd4df4f 100644
--- a/sdk/lib/async/stream.dart
+++ b/sdk/lib/async/stream.dart
@@ -77,7 +77,7 @@ abstract class Stream<T> {
}
/**
- * Whether the stream is a broadcast stream.
+ * Reports whether this stream is a broadcast stream.
*/
bool get isBroadcast => false;
@@ -97,9 +97,9 @@ abstract class Stream<T> {
}
/**
- * Add a subscription to this stream.
+ * Adds a subscription to this stream.
*
- * On each data event from this stream, the subscribers [onData] handler
+ * On each data event from this stream, the subscriber's [onData] handler
* is called. If [onData] is null, nothing happens.
*
* On errors from this stream, the [onError] handler is given a
@@ -126,7 +126,7 @@ abstract class Stream<T> {
}
/**
- * Create a new stream that converts each element of this stream
+ * Creates a new stream that converts each element of this stream
* to a new value using the [convert] function.
*/
Stream map(convert(T event)) {
@@ -134,7 +134,7 @@ abstract class Stream<T> {
}
/**
- * Create a wrapper Stream that intercepts some errors from this stream.
+ * Creates a wrapper Stream that intercepts some errors from this stream.
*
* If this stream sends an error that matches [test], then it is intercepted
* by the [handle] function.
@@ -155,7 +155,7 @@ abstract class Stream<T> {
}
/**
- * Create a new stream from this stream that converts each element
+ * Creates a new stream from this stream that converts each element
* into zero or more events.
*
* Each incoming event is converted to an [Iterable] of new events,
@@ -167,14 +167,14 @@ abstract class Stream<T> {
}
/**
- * Bind this stream as the input of the provided [StreamConsumer].
+ * Binds this stream as the input of the provided [StreamConsumer].
*/
Future pipe(StreamConsumer<T, dynamic> streamConsumer) {
return streamConsumer.consume(this);
}
/**
- * Chain this stream as the input of the provided [StreamTransformer].
+ * Chains this stream as the input of the provided [StreamTransformer].
*
* Returns the result of [:streamTransformer.bind:] itself.
*/
@@ -225,7 +225,7 @@ abstract class Stream<T> {
/**
- * Check whether [match] occurs in the elements provided by this stream.
+ * Checks whether [match] occurs in the elements provided by this stream.
*
* Completes the [Future] when the answer is known.
* If this stream reports an error, the [Future] will report that error.
@@ -257,7 +257,7 @@ abstract class Stream<T> {
}
/**
- * Check whether [test] accepts all elements provided by this stream.
+ * Checks whether [test] accepts all elements provided by this stream.
*
* Completes the [Future] when the answer is known.
* If this stream reports an error, the [Future] will report that error.
@@ -289,7 +289,7 @@ abstract class Stream<T> {
}
/**
- * Check whether [test] accepts any element provided by this stream.
+ * Checks whether [test] accepts any element provided by this stream.
*
* Completes the [Future] when the answer is known.
* If this stream reports an error, the [Future] will report that error.
@@ -440,7 +440,7 @@ abstract class Stream<T> {
return future;
}
- /** Collect the data of this stream in a [List]. */
+ /** Collects the data of this stream in a [List]. */
Future<List<T>> toList() {
List<T> result = <T>[];
_FutureImpl<List<T>> future = new _FutureImpl<List<T>>();
@@ -458,7 +458,7 @@ abstract class Stream<T> {
return future;
}
- /** Collect the data of this stream in a [Set]. */
+ /** Collects the data of this stream in a [Set]. */
Future<Set<T>> toSet() {
Set<T> result = new Set<T>();
_FutureImpl<Set<T>> future = new _FutureImpl<Set<T>>();
@@ -477,7 +477,7 @@ abstract class Stream<T> {
}
/**
- * Provide at most the first [n] values of this stream.
+ * Provides at most the first [n] values of this stream.
*
* Forwards the first [n] data events of this stream, and all error
* events, to the returned stream, and ends with a done event.
@@ -521,7 +521,7 @@ abstract class Stream<T> {
}
/**
- * Skip data events if they are equal to the previous data event.
+ * Skips data events if they are equal to the previous data event.
*
* The returned stream provides the same events as this stream, except
* that it never provides two consequtive data events that are equal.
@@ -624,7 +624,7 @@ abstract class Stream<T> {
}
/**
- * Find the first element of this stream matching [test].
+ * Finds the first element of this stream matching [test].
*
* Returns a future that is filled with the first element of this stream
* that [test] returns true for.
« no previous file with comments | « no previous file | sdk/lib/io/http.dart » ('j') | sdk/lib/io/process.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698