Fix doc comment references (dart-lang/stream_channel#28)
diff --git a/pkgs/stream_channel/analysis_options.yaml b/pkgs/stream_channel/analysis_options.yaml index 743cc90..107424e 100644 --- a/pkgs/stream_channel/analysis_options.yaml +++ b/pkgs/stream_channel/analysis_options.yaml
@@ -6,3 +6,7 @@ unused_element: error unused_local_variable: error dead_code: error + +linter: + rules: + - comment_references
diff --git a/pkgs/stream_channel/lib/src/multi_channel.dart b/pkgs/stream_channel/lib/src/multi_channel.dart index e7e2584..a1ee057 100644 --- a/pkgs/stream_channel/lib/src/multi_channel.dart +++ b/pkgs/stream_channel/lib/src/multi_channel.dart
@@ -86,7 +86,7 @@ /// This will be `null` if the underlying communication channel is closed. StreamChannel<dynamic> _inner; - /// The subscription to [_inner.stream]. + /// The subscription to [_inner].stream. StreamSubscription<dynamic> _innerStreamSubscription; Stream<T> get stream => _mainController.foreign.stream;
diff --git a/pkgs/stream_channel/lib/src/stream_channel_controller.dart b/pkgs/stream_channel/lib/src/stream_channel_controller.dart index 45b2865..146e996 100644 --- a/pkgs/stream_channel/lib/src/stream_channel_controller.dart +++ b/pkgs/stream_channel/lib/src/stream_channel_controller.dart
@@ -50,8 +50,8 @@ /// /// If [allowForeignErrors] is `false`, errors are not allowed to be passed to /// the foreign channel's sink. If any are, the connection will close and the - /// error will be forwarded to the foreign channel's [Sink.done] future. This - /// guarantees that the local stream will never emit errors. + /// error will be forwarded to the foreign channel's [StreamSink.done] future. + /// This guarantees that the local stream will never emit errors. StreamChannelController({bool allowForeignErrors: true, bool sync: false}) { var localToForeignController = new StreamController<T>(sync: sync); var foreignToLocalController = new StreamController<T>(sync: sync);
diff --git a/pkgs/stream_channel/lib/src/stream_channel_transformer.dart b/pkgs/stream_channel/lib/src/stream_channel_transformer.dart index 4fcd3cd..cc9bad8 100644 --- a/pkgs/stream_channel/lib/src/stream_channel_transformer.dart +++ b/pkgs/stream_channel/lib/src/stream_channel_transformer.dart
@@ -23,8 +23,8 @@ /// the stream to close before it emits any more events. This guarantee is /// invalidated when an asynchronous gap is added between the original stream's /// event dispatch and the returned stream's, for example by transforming it -/// with a [StreamTransformer]. The guarantee can be easily preserved using [new -/// StreamChannel.withCloseGuarantee]. +/// with a [StreamTransformer]. The guarantee can be easily preserved using +/// [StreamChannel.withCloseGuarantee]. class StreamChannelTransformer<S, T> { /// The transformer to use on the channel's stream. final StreamTransformer<T, S> _streamTransformer;
diff --git a/pkgs/stream_channel/lib/stream_channel.dart b/pkgs/stream_channel/lib/stream_channel.dart index 8d0e604..ce3cf04 100644 --- a/pkgs/stream_channel/lib/stream_channel.dart +++ b/pkgs/stream_channel/lib/stream_channel.dart
@@ -25,8 +25,8 @@ /// canonical indicator that the channel has closed. If they wish to close the /// channel, they should close the [sink]—canceling the stream subscription is /// not sufficient. Protocol errors may be emitted through the stream or through -/// [Sink.done], depending on their underlying cause. Note that the sink may -/// silently drop events if the channel closes before [Sink.close] is called. +/// [sink].done, depending on their underlying cause. Note that the sink may +/// silently drop events if the channel closes before [sink].close is called. /// /// Implementations are strongly encouraged to mix in or extend /// [StreamChannelMixin] to get default implementations of the various instance @@ -43,7 +43,7 @@ /// /// * After the stream closes, the sink is automatically closed. If this /// happens, sink methods should silently drop their arguments until -/// [Sink.close] is called. +/// [sink].close is called. /// /// * If the stream closes before it has a listener, the sink should silently /// drop events if possible. @@ -53,7 +53,7 @@ /// even after the subscription has been canceled. /// /// * The sink *either* forwards errors to the other endpoint *or* closes as -/// soon as an error is added and forwards that error to the [Sink.done] +/// soon as an error is added and forwards that error to the [sink].done /// future. /// /// These guarantees allow users to interact uniformly with all implementations, @@ -69,8 +69,8 @@ /// Creates a new [StreamChannel] that communicates over [stream] and [sink]. /// /// Note that this stream/sink pair must provide the guarantees listed in the - /// [StreamChannel] documentation. If they don't do so natively, [new - /// StreamChannel.withGuarantees] should be used instead. + /// [StreamChannel] documentation. If they don't do so natively, + /// [StreamChannel.withGuarantees] should be used instead. factory StreamChannel(Stream<T> stream, StreamSink<T> sink) => new _StreamChannel<T>(stream, sink); @@ -83,7 +83,7 @@ /// /// If [allowSinkErrors] is `false`, errors are not allowed to be passed to /// [sink]. If any are, the connection will close and the error will be - /// forwarded to [Sink.done]. + /// forwarded to [sink].done. factory StreamChannel.withGuarantees(Stream<T> stream, StreamSink<T> sink, {bool allowSinkErrors: true}) => new GuaranteeChannel(stream, sink, allowSinkErrors: allowSinkErrors); @@ -101,33 +101,33 @@ Stream<T> stream, StreamSink<T> sink) => new CloseGuaranteeChannel(stream, sink); - /// Connects [this] to [other], so that any values emitted by either are sent + /// Connects this to [other], so that any values emitted by either are sent /// directly to the other. void pipe(StreamChannel<T> other); - /// Transforms [this] using [transformer]. + /// Transforms this using [transformer]. /// /// This is identical to calling `transformer.bind(channel)`. StreamChannel<S> transform<S>(StreamChannelTransformer<S, T> transformer); - /// Transforms only the [stream] component of [this] using [transformer]. + /// Transforms only the [stream] component of this using [transformer]. StreamChannel<T> transformStream(StreamTransformer<T, T> transformer); - /// Transforms only the [sink] component of [this] using [transformer]. + /// Transforms only the [sink] component of this using [transformer]. StreamChannel<T> transformSink(StreamSinkTransformer<T, T> transformer); - /// Returns a copy of [this] with [stream] replaced by [change]'s return + /// Returns a copy of this with [stream] replaced by [change]'s return /// value. StreamChannel<T> changeStream(Stream<T> change(Stream<T> stream)); - /// Returns a copy of [this] with [sink] replaced by [change]'s return + /// Returns a copy of this with [sink] replaced by [change]'s return /// value. StreamChannel<T> changeSink(StreamSink<T> change(StreamSink<T> sink)); - /// Returns a copy of [this] with the generic type coerced to [S]. + /// Returns a copy of this with the generic type coerced to [S]. /// /// If any events emitted by [stream] aren't of type [S], they're converted - /// into [CastError] events. Similarly, if any events are added to [sync] that + /// into [CastError] events. Similarly, if any events are added to [sink] that /// aren't of type [S], a [CastError] is thrown. StreamChannel<S> cast<S>(); }