Add a README file to the meta package

Change-Id: Id8e9587a0a0f3573dcc713c9244c11d0d142a494
Reviewed-on: https://dart-review.googlesource.com/30140
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
This commit is contained in:
Brian Wilkerson 2017-12-17 21:53:17 +00:00 committed by commit-bot@chromium.org
parent 075720c352
commit 7ed0bccca8
2 changed files with 35 additions and 1 deletions

34
pkg/meta/README.md Normal file
View file

@ -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

View file

@ -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;