Skip to content

@docImports should support as imports #56527

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

Open
goderbauer opened this issue Aug 20, 2024 · 1 comment
Open

@docImports should support as imports #56527

goderbauer opened this issue Aug 20, 2024 · 1 comment
Labels
area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. devexp-server Issues related to some aspect of the analysis server P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@goderbauer
Copy link
Contributor

Something like this should work:

/// @docImport 'dart:io' as io;
library;

/// You can use [io.Stdin] to...
void foo() {
  // intentionally left blank
}
@dart-github-bot
Copy link
Collaborator

Summary: The @docImport annotation currently doesn't support the as keyword for aliasing imported libraries, making it difficult to reference imported symbols in documentation comments. This issue proposes adding support for as imports within @docImport annotations.

@dart-github-bot dart-github-bot added area-language Dart language related items (some items might be better tracked at github.com/dart-lang/language). triage-automation See https://github.com/dart-lang/ecosystem/tree/main/pkgs/sdk_triage_bot. type-enhancement A request for a change that isn't a bug labels Aug 20, 2024
@srawlins srawlins added legacy-area-analyzer Use area-devexp instead. devexp-server Issues related to some aspect of the analysis server P2 A bug or feature request we're likely to work on and removed area-language Dart language related items (some items might be better tracked at github.com/dart-lang/language). labels Aug 20, 2024
@devoncarew devoncarew removed the triage-automation See https://github.com/dart-lang/ecosystem/tree/main/pkgs/sdk_triage_bot. label Aug 22, 2024
@bwilkerson bwilkerson added area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. and removed legacy-area-analyzer Use area-devexp instead. labels Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-devexp For issues related to the analysis server, IDE support, linter, `dart fix`, and diagnostic messages. devexp-server Issues related to some aspect of the analysis server P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

5 participants