Skip to content
This repository has been archived by the owner on Aug 1, 2019. It is now read-only.

Commit

Permalink
Fix some doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kevmoo committed May 20, 2016
1 parent 167eb9c commit 83ae219
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 18 deletions.
2 changes: 1 addition & 1 deletion lib/src/isolate.dart
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ class VMIsolateRef {
/// If [includeCoverageReport] is `true`, the report includes code coverage
/// information via [VMSourceReportRange.hits] and
/// [VMSourceReportRange.misses] in [VMSourceReport.ranges]. Otherwise,
/// [VMSourceReportRange.coverage] is `null`.
/// these properties are `null`.
///
/// If [includePossibleBreakpoints] is `true`, the report includes a list of
/// token positions which correspond to possible breakpoints via
Expand Down
4 changes: 2 additions & 2 deletions lib/src/script.dart
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ class VMScript extends VMScriptRef implements VMObject {
/// Note that [FileLocation] uses 0-based lines and columns, whereas the rest
/// of this package uses 1-based lines and columns.
///
/// Throws an [ArgumentError] if [location] isn't for this script.
/// Throws an [ArgumentError] if [token] isn't for this script.
FileLocation sourceLocation(VMScriptToken token) {
if (token._isolateId != _scope.isolateId ||
(_fixedId && token._scriptId != _id)) {
Expand Down Expand Up @@ -242,7 +242,7 @@ class VMScript extends VMScriptRef implements VMObject {

/// The location of a token in a Dart script.
///
/// A token can be passed to [VMScriptRef.sourceLocation] to get the line and
/// A token can be passed to [VMScript.sourceLocation] to get the line and
/// column information for the token.
class VMScriptToken {
/// The ID of this token's script's isolate.
Expand Down
21 changes: 6 additions & 15 deletions lib/vm_service_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -121,28 +121,19 @@ class VMServiceClient {
return new VMServiceClient(new IOWebSocketChannel.connect(uri));
}

/// Creates a client that reads incoming messages from [incoming] and writes
/// outgoing messages to [outgoing].
///
/// If [incoming] is a [StreamSink] as well as a [Stream] (for example, a
/// [WebSocket]), [outgoing] may be omitted.
/// Creates a client that reads incoming messages from a [channel] which
/// contains JSON-encoded [String] instances.
///
/// This is useful when using the client over a pre-existing connection. To
/// establish a connection from scratch, use [connect].
/// establish a connection from scratch, use [VMServiceClient.connect].
factory VMServiceClient(StreamChannel<String> channel) =>
new VMServiceClient.withoutJson(jsonDocument.bind(channel));

/// Creates a client that reads incoming decoded messages from [incoming] and
/// writes outgoing decoded messages to [outgoing].
///
/// Unlike [new VMServiceClient], this doesn't read or write JSON strings.
/// Instead, it reads and writes decoded maps.
///
/// If [incoming] is a [StreamSink] as well as a [Stream], [outgoing] may be
/// omitted.
/// Creates a client that reads incoming messages from a [channel] which
/// contains decoded JSON maps and lists.
///
/// This is useful when using the client over a pre-existing connection. To
/// establish a connection from scratch, use [connect].
/// establish a connection from scratch, use [VMServiceClient.connect].
factory VMServiceClient.withoutJson(StreamChannel channel) =>
new VMServiceClient._(new rpc.Peer.withoutJson(
channel.transformStream(v1CompatibilityTransformer)));
Expand Down

0 comments on commit 83ae219

Please sign in to comment.