OLD | NEW |
1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /// Source maps library. | 5 /// Source maps library. |
6 /// | 6 /// |
| 7 /// ## Installing ## |
| 8 /// |
| 9 /// Use [pub][] to install this package. Add the following to your |
| 10 /// `pubspec.yaml` file. |
| 11 /// |
| 12 /// dependencies: |
| 13 /// source_maps: any |
| 14 /// |
| 15 /// Then run `pub install`. |
| 16 /// |
| 17 /// For more information, see the |
| 18 /// [source_maps package on pub.dartlang.org][pkg]. |
| 19 /// |
| 20 /// ## Using ## |
| 21 /// |
7 /// Create a source map using [SourceMapBuilder]. For example: | 22 /// Create a source map using [SourceMapBuilder]. For example: |
8 /// var json = (new SourceMapBuilder() | 23 /// var json = (new SourceMapBuilder() |
9 /// ..add(inputSpan1, outputSpan1) | 24 /// ..add(inputSpan1, outputSpan1) |
10 /// ..add(inputSpan2, outputSpan2) | 25 /// ..add(inputSpan2, outputSpan2) |
11 /// ..add(inputSpan3, outputSpan3) | 26 /// ..add(inputSpan3, outputSpan3) |
12 /// .toJson(outputFile); | 27 /// .toJson(outputFile); |
13 /// | 28 /// |
14 /// Use the [Span] and [SourceFile] classes to specify span locations. | 29 /// Use the [Span] and [SourceFile] classes to specify span locations. |
15 /// | 30 /// |
16 /// Parse a source map using [parse], and call `spanFor` on the returned mapping | 31 /// Parse a source map using [parse], and call `spanFor` on the returned mapping |
17 /// object. For example: | 32 /// object. For example: |
18 /// var mapping = parse(json); | 33 /// var mapping = parse(json); |
19 /// mapping.spanFor(outputSpan1.line, outputSpan1.column) | 34 /// mapping.spanFor(outputSpan1.line, outputSpan1.column) |
| 35 /// |
| 36 /// [pub]: http://pub.dartlang.org |
| 37 /// [pkg]: http://pub.dartlang.org/packages/source_maps |
20 library source_maps; | 38 library source_maps; |
21 | 39 |
22 export "builder.dart"; | 40 export "builder.dart"; |
23 export "parser.dart"; | 41 export "parser.dart"; |
24 export "printer.dart"; | 42 export "printer.dart"; |
25 export "span.dart"; | 43 export "span.dart"; |
OLD | NEW |