Repository navigation
Some doc comments refer to unknown, or out of scope, code identifiers. #150562
Description
Here's the main list. Some just need to use backticks instead of square brackets. Some should just not have square brackets. Some are typos. Some need broader textual refactoring:
- *
DragGestureRecognizer.onCancel- property referencingallowedButtonsFilter. - *
DragGestureRecognizer.onDown- property referencingallowedButtonsFilter. - *
DragGestureRecognizer.onEnd- property referencingallowedButtonsFilter. - *
DragGestureRecognizer.onStart- property referencingallowedButtonsFilter. - *
DragGestureRecognizer.onUpdate- property referencingallowedButtonsFilter. - *
DoubleTapGestureRecognizer.onDoubleTap- property referencingallowedButtonsFilter. - *
DoubleTapGestureRecognizer.onDoubleTapCancel- property referencing referencingallowedButtonsFilter. - *
DoubleTapGestureRecognizer.onDoubleTapDown- property referencingallowedButtonsFilter. - *
TapGestureRecognizer- class referencingallowedButtonsFilter. - *
Badge.backgroundColor- property referencingColorScheme.errorColor. - *
ButtonThemeData.padding- property referencingbutton. - *
ButtonThemeData.shape- property referencingbutton. - *
InkSparkle- class referencingcontainedInkWell. - *
InkSparkle- class referencingrectCallback. - *
InkSparkle.splashFactory- static const field referencingturbulenceSeed. - *
InkSparkle.constantTurbulenceSeedSplashFactory- static const field referencingturbulenceSeed. - *
Switch.adaptive- constructor referencingThemeData.adaptations. - *
TextButton.defaultStyleOf- method referencingpadding. - *
Adaptation.adapt- method referencingThemeData.adaptations. - *
UndoManager- Class referencingcanRedo. - *
UndoManager- Class referencingcanUndo. - *
ContextMenuController.markNeedsBuild- method referencingcontextMenuBuilder. - *
SliverFadeTransition- class referencingsliver.
And some just refer to not-properly-prefixed elements. These can be updated with a prefix:
- *
ImageInfo.clone- method referencingImage.clone. - *
ImageInfo.isCloneOf- method referencingImage.isCloneOf. - *
RawImage- class referencingImage.dispose. - *
RawImage.image- property referencingImage.dispose.
And some just refer to not-imported elements. These can be updated with @docImport:
- *
DiagnosticsNode.toTimelineArguments- method referencingTimeline.startSync. - *
compute- top-level function referencingIsolate.run.
Activity
srawlins commentedon Jun 20, 2024
CC @goderbauer
Fix a number of broken doc comment references (#150540)
goderbauer commentedon Jun 24, 2024
I am so excited! Turned the top-level comment into a checklist so we can keep track of what has been fixed. Do you want help with any of these?
goderbauer commentedon Jun 24, 2024
Oh, looks like you already fixed them all in #150540. Thank you! Can we close this issue then or is there more to do?
srawlins commentedon Jun 24, 2024
Haha you read my mind. I was also going to turn it into a checklist. I think there is more work to be done:
For all of these, I just changed
[foo]into`foo`, so they're no-op improvements as far as the rendered HTML. I think many of them refer to parameters on other methods, like a class comment refering to a parameter on a constructor. I couldn't really say, which is why I landed the no-op fixes.goderbauer commentedon Jun 24, 2024
Ah, Ok, I am fixing those (where it made sense) in #150734. Some actually need to be in `. I'll mark that PR as fixing this bug then.
Linkify 'see also' sections (#150734)
Fix a number of broken doc comment references (flutter#150540)
Linkify 'see also' sections (flutter#150734)
github-actions commentedon Jul 9, 2024
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of
flutter doctor -vand a minimal reproduction of the issue.Linkify 'see also' sections (#150734)
Linkify 'see also' sections (#150734)