Skip to content

Hide dart:web_sql in generated dartdocs #45687

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

Closed
kevmoo opened this issue Apr 14, 2021 · 6 comments
Closed

Hide dart:web_sql in generated dartdocs #45687

kevmoo opened this issue Apr 14, 2021 · 6 comments
Assignees
Labels
area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). area-web-js Issues related to JavaScript support for Dart Web, including DDC, dart2js, and JS interop. P2 A bug or feature request we're likely to work on

Comments

@kevmoo
Copy link
Member

kevmoo commented Apr 14, 2021

We plan on eliminating the API soon, but we can start by hiding it from our docs!

@kevmoo kevmoo added area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). area-web-js Issues related to JavaScript support for Dart Web, including DDC, dart2js, and JS interop. labels Apr 14, 2021
@kevmoo kevmoo added this to the May Beta Release milestone Apr 14, 2021
@sigmundch
Copy link
Member

@devoncarew @jcollins-g what would be the right process to get this library hidden?

(also, procedural question: what's the best way to track issues that directly affect dartdoc? Should we file this also under https://github.com/dart-lang/dartdoc?)

@jcollins-g
Copy link
Contributor

the quickest way to hide a library is to use @nodoc directly inside the documentation comment. You can also use the nodoc field in dartdoc_options.yaml.

https://github.com/dart-lang/dartdoc#excluding-from-documentation

@jcollins-g
Copy link
Contributor

Note that @nodoc, a bit confusingly, is not actually an annotation, just a literal string inside the documentation comment.

@jcollins-g
Copy link
Contributor

Issues that require dartdoc changes are best filed under https://github.com/dart-lang/dartdoc.

@sigmundch
Copy link
Member

Great, thanks!

@sigmundch sigmundch self-assigned this Apr 22, 2021
@devoncarew
Copy link
Member

I believe there's prior art here in the sdk - we're excluding docs for dart:cli.

@sigmundch sigmundch added the P2 A bug or feature request we're likely to work on label Apr 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-sdk Use area-sdk for general purpose SDK issues (packaging, distribution, …). area-web-js Issues related to JavaScript support for Dart Web, including DDC, dart2js, and JS interop. P2 A bug or feature request we're likely to work on
Projects
None yet
Development

No branches or pull requests

4 participants