Centralize unparsing of comment references #2630
Merged
Conversation
This file contains 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
srawlins
reviewed
Apr 28, 2021
| @@ -0,0 +1,29 @@ | |||
| // Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file | |||
| @@ -126,10 +126,6 @@ final RegExp nonHTML = | |||
| /// parentheses. | |||
| final _trailingIgnorePattern = RegExp(r'(<.*>|\(.*\)|\?|!)$'); | |||
|
|
|||
| @Deprecated('Public variable intended to be private; will be removed as early ' | |||
lib/src/markdown_processor.dart
Outdated
| @@ -369,26 +357,25 @@ MatchingLinkResult _getMatchingLinkElementLegacy(String codeRef, | |||
| } | |||
|
|
|||
| /// Given a set of commentRefs, return the one whose name matches the codeRef. | |||
There was a problem hiding this comment.
Looks like the doc comment doesn't apply any more.
There was a problem hiding this comment.
Wrote a more complete doc.
| /// [CommentReference]. | ||
| static String _referenceText( | ||
| CommentReference ref, ResourceProvider resourceProvider) { | ||
| var contents = getFileContentsFor( |
There was a problem hiding this comment.
Fortunately not. It is cached so we only pay a read penalty once per file.
jcollins-g
commented
Apr 30, 2021
| @@ -0,0 +1,29 @@ | |||
| // Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file | |||
lib/src/markdown_processor.dart
Outdated
| @@ -369,26 +357,25 @@ MatchingLinkResult _getMatchingLinkElementLegacy(String codeRef, | |||
| } | |||
|
|
|||
| /// Given a set of commentRefs, return the one whose name matches the codeRef. | |||
There was a problem hiding this comment.
Wrote a more complete doc.
srawlins
approved these changes
Apr 30, 2021
|
I have redone some benchmarks before marking this as ready for review, to make sure the changes to comment reference handling didn't harm performance. Fortunately, the delta is negligible. |
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.
Before implementing new parsing of comment references, we should clean up how dartdoc gets comment references in the first place. Unparsing them is now centralized which should make it more clear how the analyzer AST could help dartdoc by providing the raw string.
Breaking change: commentRefs, a member of ModelElements, is a map now instead of a list.