Fix doc comment references to 'this' #150379
Merged
+9
−11
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
goderbauer
approved these changes
Jun 17, 2024
Comment on lines
3881
to
3882
| /// If `this.value` is set, [increasedValue] must also be provided and | ||
| /// [onIncrease] must ensure that `this.value` will be set to |
Member
There was a problem hiding this comment.
I think this should be:
Suggested change
| /// If `this.value` is set, [increasedValue] must also be provided and | |
| /// [onIncrease] must ensure that `this.value` will be set to | |
| /// If [value] is set, [increasedValue] must also be provided and | |
| /// [onIncrease] must ensure that [value] will be set to |
Comment on lines
3900
to
3901
| /// If `this.value` is set, [decreasedValue] must also be provided and | ||
| /// [onDecrease] must ensure that `this.value` will be set to |
Member
There was a problem hiding this comment.
Suggested change
| /// If `this.value` is set, [decreasedValue] must also be provided and | |
| /// [onDecrease] must ensure that `this.value` will be set to | |
| /// If [value] is set, [decreasedValue] must also be provided and | |
| /// [onDecrease] must ensure that [value] will be set to |
| } | ||
|
|
||
| /// Whether [this.value] should be obscured. | ||
| /// Whether `this.value` should be obscured. |
Member
There was a problem hiding this comment.
Suggested change
| /// Whether `this.value` should be obscured. | |
| /// Whether [value] should be obscured. |
| /// This option is usually set in combination with [isTextField] to indicate | ||
| /// that the text field contains a password (or other sensitive information). | ||
| /// Doing so instructs screen readers to not read out [this.value]. | ||
| /// Doing so instructs screen readers to not read out `this.value`. |
Member
There was a problem hiding this comment.
Suggested change
| /// Doing so instructs screen readers to not read out `this.value`. | |
| /// Doing so instructs screen readers to not read out [value]. |
|
|
||
| /// The currently selected text (or the position of the cursor) within | ||
| /// [this.value] if this node represents a text field. | ||
| /// `this.value` if this node represents a text field. |
Member
There was a problem hiding this comment.
Suggested change
| /// `this.value` if this node represents a text field. | |
| /// [value] if this node represents a text field. |
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 18, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 18, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 18, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 18, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 19, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 19, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 20, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 20, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 20, 2024
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
Jun 20, 2024
Manual roll requested by stuartmorgan@google.com flutter/flutter@ccf3abe...6c06abb 2024-06-18 magder@google.com Add test for engine artifact framework permissions (flutter/flutter#148786) 2024-06-18 32538273+ValentinVignal@users.noreply.github.com Add test for icon_button.3.dart (flutter/flutter#149988) 2024-06-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 78fdd06af541 to 74f42ca3544c (6 revisions) (flutter/flutter#150421) 2024-06-18 tessertaha@gmail.com Fix transparent `dividerColor` breaks `TabBar.tabAlignment` (flutter/flutter#150350) 2024-06-18 tessertaha@gmail.com Fix scrollable `TabBar` jittering (flutter/flutter#150041) 2024-06-18 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Reland 3: [CupertinoActionSheet] Match colors to native (#150386)" (flutter/flutter#150413) 2024-06-18 jason-simmons@users.noreply.github.com Extend the Windows web_tool_tests_1_2 shard timeout to 45 minutes (flutter/flutter#150393) 2024-06-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 1c4e5e230ecb to 78fdd06af541 (3 revisions) (flutter/flutter#150403) 2024-06-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from a4f266f7eb1a to 1c4e5e230ecb (8 revisions) (flutter/flutter#150399) 2024-06-18 parlough@gmail.com Rename doc file to use standard hyphens (flutter/flutter#150314) 2024-06-17 120297255+PurplePolyhedron@users.noreply.github.com Fix typo in `SliverLayoutDimensions.hashCode` where not all properties are used in the hash code. (flutter/flutter#150306) 2024-06-17 srawlins@google.com Fix doc comment references to 'this' (flutter/flutter#150379) 2024-06-17 Lexycon@users.noreply.github.com Add 'fail-fast' argument to flutter test (flutter/flutter#149587) 2024-06-17 dev@alestiago.com Update matchesGoldenFile documentation reference to goldenFileComparator (flutter/flutter#150343) 2024-06-17 dkwingsmt@users.noreply.github.com Reland 3: [CupertinoActionSheet] Match colors to native (flutter/flutter#150386) 2024-06-17 jhy03261997@gmail.com [a11y] Add semantics: button to bottom navigation bar items and dropdown menu items (flutter/flutter#149375) 2024-06-17 yinxulolol@gmail.com Reland "sliverGridDelegate mainAxisExtent add assert (#148470)" (flutter/flutter#149720) 2024-06-17 36861262+QuncCccccc@users.noreply.github.com `ScaffoldBackgroundColor` should default to `ColorScheme.surface` (flutter/flutter#149772) 2024-06-17 katelovett@google.com Reland TreeSliver (flutter/flutter#149839) 2024-06-17 dkwingsmt@users.noreply.github.com Reland: [CupertinoActionSheet] Add sliding tap gesture (flutter/flutter#150219) 2024-06-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from 5989f0215fed to a4f266f7eb1a (1 revision) (flutter/flutter#150377) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Work towards dart-lang/dartdoc#3761
Sibling CL to https://dart-review.googlesource.com/c/sdk/+/365204
The analyzer has never recognized
[this]as a valid doc commentreference (and the
comment_referenceslint rule has similarlyreported such reference attempts). dartdoc has its own algorithms
for resolving comment references, which we are dismantling in favor
of a single resolution, provided by the analyzer.
We've also decided against adding support in the analyzer (see
dart-lang/sdk#58155), so these
reference attempts should be re-written.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.