Document @docImport in README.md
#3935
Open
+18
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implemented in dart-lang/sdk#56186 Credits @srawlins
|
Thanks for the PR! I'd like to put this off until the implementation is a little bit tidied. There are a few items I hope to finish this quarter before "releasing" the feature:
|
This was referenced Jan 10, 2025
|
@srawlins, what about this PR now that we have https://dart.dev/tools/doc-comments/references#doc-imports? |
|
Oh wow, blast from the past 😅 yes I'll review this anew. |
srawlins
reviewed
May 21, 2025
|
|
||
| ```dart | ||
| /// @docImport 'dart:async'; | ||
| /// @docImport 'package:flutter/element.dart' show Element; |
There was a problem hiding this comment.
'show' is not supported. (yet?)
There was a problem hiding this comment.
Exactly. Noting the umbrella issue for it does mention this was a goal dart-lang/sdk#56186.
srawlins
reviewed
May 21, 2025
| /// @docImport 'dart:async'; | ||
| /// @docImport 'package:flutter/element.dart' show Element; | ||
| /// @docImport '../path/to/somwhere.dart'; | ||
| /// @docImport 'dart:html' as 'html'; |
There was a problem hiding this comment.
Exactly. Noting we have an issue for it dart-lang/sdk#56527 and the umbrella issue for it does mention this was a goal dart-lang/sdk#56186.
srawlins
approved these changes
May 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implemented in dart-lang/sdk#56186 (credits @@srawlins).
We should probably document this on
dart.devtoo. But I figured it would be harmless to add it to dartdoc. This is certainly one of the placed I went to look for it 🤣