From 7ed0bccca828cd9b16dc7f64e4b10a17fa80c243 Mon Sep 17 00:00:00 2001 From: Brian Wilkerson Date: Sun, 17 Dec 2017 21:53:17 +0000 Subject: [PATCH] Add a README file to the meta package Change-Id: Id8e9587a0a0f3573dcc713c9244c11d0d142a494 Reviewed-on: https://dart-review.googlesource.com/30140 Reviewed-by: Samuel Rawlins Commit-Queue: Brian Wilkerson --- pkg/meta/README.md | 34 ++++++++++++++++++++++++++++++++++ pkg/meta/lib/dart2js.dart | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 pkg/meta/README.md diff --git a/pkg/meta/README.md b/pkg/meta/README.md new file mode 100644 index 00000000000..c6c710d9d8d --- /dev/null +++ b/pkg/meta/README.md @@ -0,0 +1,34 @@ +# Annotations for Static Analysis + +This package defines annotations that can be used by the tools that are shipped +with the Dart SDK. + +## Library Structure + +The annotations in this package are defined in two libraries. + +The library in `meta.dart` defines annotations that can be used by static +analysis tools to provide a more complete analysis of the code that uses them. +Within the SDK, these tools include the command-line analyzer (`dartanalyzer`) +and the analysis server that is used to power many of the Dart-enabled +development tools. + +The library in `dart2js.dart` defines annotations that provide hints to dart2js +to improve the quality of the JavaScript code that it produces. These +annotations are currently experimental and might be removed in a future version +of this package. + +## Support + +Post issues and feature requests on the GitHub [issue tracker][issues]. + +Questions and discussions are welcome at the +[Dart Analyzer Discussion Group][list]. + +## License + +See the [LICENSE][license] file. + +[issues]: https://github.com/dart-lang/sdk/issues +[license]: https://github.com/dart-lang/sdk/blob/master/pkg/analyzer/LICENSE +[list]: https://groups.google.com/a/dartlang.org/forum/#!forum/analyzer-discuss diff --git a/pkg/meta/lib/dart2js.dart b/pkg/meta/lib/dart2js.dart index 71e6d33f986..4dc1ba7d49d 100644 --- a/pkg/meta/lib/dart2js.dart +++ b/pkg/meta/lib/dart2js.dart @@ -5,7 +5,7 @@ /// Constants for use in metadata annotations to provide hints to dart2js. /// /// This is an experimental feature and not expected to be useful except for low -/// level framwork authors. +/// level framework authors. /// /// Added at sdk version 2.0.0-dev.6.0 library meta_dart2js;