dart-sdk/pkg/meta
Parker Lougheed bcfab01e87 [meta] Cleanup API docs and clarify superseded annotation status
This CL standardizes some comment formats, adds a few missing doc comments, and updates a few others.

It also adds text to a few annotations indicating they are likely to be deprecated in a future release and what the migration path is.

Contributes to https://github.com/dart-lang/sdk/issues/54389

Change-Id: I4fc6d9767378b855a1ab2a1978747fbe18850605
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/342281
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Auto-Submit: Parker Lougheed <parlough@gmail.com>
Commit-Queue: Samuel Rawlins <srawlins@google.com>
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
2024-01-10 02:10:36 +00:00
..
lib [meta] Cleanup API docs and clarify superseded annotation status 2024-01-10 02:10:36 +00:00
analysis_options.yaml + flutter_style_todos 2023-11-13 00:14:09 +00:00
CHANGELOG.md [meta] Cleanup API docs and clarify superseded annotation status 2024-01-10 02:10:36 +00:00
LICENSE Update LICENSE 2021-04-07 10:28:38 +00:00
OWNERS [infra] Add OWNERS to the Dart SDK 2022-02-14 14:06:34 +00:00
pubspec.yaml [meta] Cleanup API docs and clarify superseded annotation status 2024-01-10 02:10:36 +00:00
README.md [pkg/meta] prep for publishing package:meta 1.8.0 2022-05-16 21:56:05 +00:00

pub package package publisher

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 (dart analyze) 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.

Questions and discussions are welcome at the Dart Analyzer Discussion Group.

License

See the LICENSE file.