Fix a number of doc comments Enable corresponding lint
diff --git a/pkgs/source_maps/CHANGELOG.md b/pkgs/source_maps/CHANGELOG.md index af62d94..73bbed0 100644 --- a/pkgs/source_maps/CHANGELOG.md +++ b/pkgs/source_maps/CHANGELOG.md
@@ -1,3 +1,7 @@ +## 0.10.9-dev + +* Fix a number of document comment issues. + ## 0.10.8 * Preserve source-map extensions in `SingleMapping`. Extensions are keys in the
diff --git a/pkgs/source_maps/analysis_options.yaml b/pkgs/source_maps/analysis_options.yaml index 108d105..4f9dfb0 100644 --- a/pkgs/source_maps/analysis_options.yaml +++ b/pkgs/source_maps/analysis_options.yaml
@@ -1 +1,5 @@ include: package:pedantic/analysis_options.yaml + +linter: + rules: + - comment_references
diff --git a/pkgs/source_maps/lib/builder.dart b/pkgs/source_maps/lib/builder.dart index 5574f0d..e6b8d82 100644 --- a/pkgs/source_maps/lib/builder.dart +++ b/pkgs/source_maps/lib/builder.dart
@@ -31,7 +31,7 @@ /// /// If [isIdentifier] is true or if [target] is a [SourceMapSpan] with /// `isIdentifier` set to true, this entry is considered to represent an - /// identifier whose value will be stored in the source map. [isIdenfier] + /// identifier whose value will be stored in the source map. [isIdentifier] /// takes precedence over [target]'s `isIdentifier` value. void addSpan(SourceSpan source, SourceSpan target, {bool isIdentifier}) { isIdentifier ??= source is SourceMapSpan ? source.isIdentifier : false;
diff --git a/pkgs/source_maps/lib/parser.dart b/pkgs/source_maps/lib/parser.dart index c15ff2a..124ef6d 100644 --- a/pkgs/source_maps/lib/parser.dart +++ b/pkgs/source_maps/lib/parser.dart
@@ -264,9 +264,10 @@ /// The [SourceFile]s to which the entries in [lines] refer. /// /// This is in the same order as [urls]. If this was constructed using - /// [fromEntries], this contains files from any [FileLocation]s used to build - /// the mapping. If it was parsed from JSON, it contains files for any sources - /// whose contents were provided via the `"sourcesContent"` field. + /// [SingleMapping.fromEntries], this contains files from any [FileLocation]s + /// used to build the mapping. If it was parsed from JSON, it contains files + /// for any sources whose contents were provided via the `"sourcesContent"` + /// field. /// /// Files whose contents aren't available are `null`. final List<SourceFile> files; @@ -425,8 +426,8 @@ /// Encodes the Mapping mappings as a json map. /// - /// If [sourcesContent] is `true`, this includes the source file contents from - /// [files] in the map if possible. + /// If [includeSourceContents] is `true`, this includes the source file + /// contents from [files] in the map if possible. Map toJson({bool includeSourceContents = false}) { var buff = StringBuffer(); var line = 0;
diff --git a/pkgs/source_maps/lib/printer.dart b/pkgs/source_maps/lib/printer.dart index 24eec64..d79d2cb 100644 --- a/pkgs/source_maps/lib/printer.dart +++ b/pkgs/source_maps/lib/printer.dart
@@ -160,7 +160,7 @@ /// separately and will not include any the indentation set here. /// /// The [location] and [span] parameters indicate the corresponding source map - /// location of [object] in the original input. Only one, [location] or + /// location of [line] in the original input. Only one, [location] or /// [span], should be provided at a time. void addLine(String line, {SourceLocation location, SourceSpan span}) { if (location != null || span != null) {
diff --git a/pkgs/source_maps/lib/refactor.dart b/pkgs/source_maps/lib/refactor.dart index 32daf32..5e117e8 100644 --- a/pkgs/source_maps/lib/refactor.dart +++ b/pkgs/source_maps/lib/refactor.dart
@@ -38,9 +38,9 @@ file != null ? file.location(offset) : null; /// Applies all pending [edit]s and returns a [NestedPrinter] containing the - /// rewritten string and source map information. [filename] is given to the - /// underlying printer to indicate the name of the generated file that will - /// contains the source map information. + /// rewritten string and source map information. [file]`.location` is given to + /// the underlying printer to indicate the name of the generated file that + /// will contains the source map information. /// /// Throws [UnsupportedError] if the edits were overlapping. If no edits were /// made, the printer simply contains the original string.
diff --git a/pkgs/source_maps/lib/source_maps.dart b/pkgs/source_maps/lib/source_maps.dart index e77ac59..0d17178 100644 --- a/pkgs/source_maps/lib/source_maps.dart +++ b/pkgs/source_maps/lib/source_maps.dart
@@ -18,25 +18,13 @@ /// object. For example: /// var mapping = parse(json); /// mapping.spanFor(outputSpan1.line, outputSpan1.column) -/// -/// ## Getting the code ## -/// -/// This library is distributed as a [pub][] package. To install this package, -/// add the following to your `pubspec.yaml` file: -/// -/// dependencies: -/// source_maps: any -/// -/// After you run `pub install`, you should be able to access this library by -/// importing `package:source_maps/source_maps.dart`. -/// -/// For more information, see the -/// [source_maps package on pub.dartlang.org][pkg]. -/// -/// [pub]: http://pub.dartlang.org -/// [pkg]: http://pub.dartlang.org/packages/source_maps library source_maps; +import 'package:source_span/source_span.dart'; + +import 'parser.dart'; +import 'builder.dart'; + export 'builder.dart'; export 'parser.dart'; export 'printer.dart';
diff --git a/pkgs/source_maps/lib/src/vlq.dart b/pkgs/source_maps/lib/src/vlq.dart index de3ab27..d4e29a1 100644 --- a/pkgs/source_maps/lib/src/vlq.dart +++ b/pkgs/source_maps/lib/src/vlq.dart
@@ -9,8 +9,7 @@ /// encodes a 5-bit value (0-31) and a continuation bit. Signed values can be /// represented by using the least significant bit of the value as the sign bit. /// -/// For more details see the source map [version 3 documentation][spec]. -/// [spec]: https://docs.google.com/a/google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit +/// For more details see the source map [version 3 documentation](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit?usp=sharing). library source_maps.src.vlq; import 'dart:math';