New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve MirrorsUsed API docs #15656
Comments
FWIW, the issue with MirrorsUsed is not simply documentation. It goes much deeper. We still have not figured out the best (or even a good) model for how to communicate information about reflective usage to the system. MirrorsUsed is a stop-gap. Once we know how it should work, we can document it. |
But... it's what we're telling people to use, for now. Can't we do just a wee bit of doc? The constructor has no description at all, so I have no idea of what "targets" and "metaTargets" mean, e.g. |
Reassign to dart2js land. Set owner to @floitschG. |
Removed Area-Documentation, Type-Defect, Priority-High labels. |
Copied from internal bug-tracker (thanks Chris): MirrorsUsed has been around for >= 1.5 years, yet its api remains too non-committal to be useful, e.g. here are some docs, just to show the level of specificity that would make it usable,
|
Added Started label. |
I improved the dartdoc for MirrorsUsed in https://codereview.chromium.org/1122983002/ The purpose is not to discuss the design of MirrorsUsed but merely describe the behaviour of the current implementation in dart2js. Comments here or on the CL most welcome. |
This has now landed in r45585. Added Done label. |
We should fix the MirrorsUsed API docs ASAP so that people can use @MirrorsUsed annotations correctly.
Another possibility (for quicker resolution) is explaining MirrorsUsed somewhere (group? blog?) and then linking from the docs to there.
https://api.dartlang.org/dart_mirrors/MirrorsUsed.html
The text was updated successfully, but these errors were encountered: