[tool] Fix broken comment references and code spans in doc comments #168498

parlough · 2025-05-07T18:52:26Z

Enables the comment_references and unintended_html_in_doc_comment lints in packages/flutter_tool, then fixes each of the triggering cases.

This PR is test exempt due to only affecting documentation comments.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

LouiseHsu

lgtm!

…comments (flutter/flutter#168498)

[tool] Fix broken comment references and code blocks in doc comments

275acd8

github-actions bot added platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. a: desktop Running on desktop team-ios Owned by iOS platform team labels May 7, 2025

Merge branch 'main' into fix/tool-doc-comments

75912c4

parlough changed the title ~~[tool] Fix broken comment references and code blocks in doc comments~~ [tool] Fix broken comment references and code spans in doc comments May 9, 2025

parlough marked this pull request as ready for review May 9, 2025 21:24

parlough requested a review from a team as a code owner May 9, 2025 21:24

LouiseHsu approved these changes May 12, 2025

View reviewed changes

Merge branch 'main' into fix/tool-doc-comments

b4f390b

jmagman added this to Google Testing Queue May 15, 2025

jmagman added the autosubmit Merge PR when tree becomes green via auto submit App label May 15, 2025

auto-submit bot added this pull request to the merge queue May 15, 2025

Merged via the queue into flutter:master with commit 77ba015 May 15, 2025
142 checks passed

github-project-automation bot moved this to Done in Google Testing Queue May 15, 2025

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 15, 2025

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

ff84c97

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to c685293fc40c (11 revisions) flutter/packages#9262

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

a0043e4

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to a2c2d2c8dea5 (12 revisions) flutter/packages#9263

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

96d4636

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to 7cbb76d147e8 (13 revisions) flutter/packages#9265

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

f677235

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to 8ae7b522dc0f (14 revisions) flutter/packages#9266

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

2171bc0

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to 57dd0de38cd5 (15 revisions) flutter/packages#9269

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

b4a810b

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 16, 2025

Roll Flutter from 9a78af5eb067 to 3c6f74c799af (16 revisions) flutter/packages#9271

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 18, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

cdadb3d

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 18, 2025

Roll Flutter from 9a78af5eb067 to a682cf27b237 (29 revisions) flutter/packages#9279

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

47fd409

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 154146d0dd87 (31 revisions) flutter/packages#9285

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

5680853

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 63f9060fb030 (32 revisions) flutter/packages#9286

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

39104f6

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to b23840d04447 (33 revisions) flutter/packages#9288

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

c7657a7

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 25692db52876 (34 revisions) flutter/packages#9289

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

db9e465

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 559c314ba3fd (35 revisions) flutter/packages#9290

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

7874d18

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 5bcde8fa7b82 (36 revisions) flutter/packages#9291

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 19, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

916a7cd

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 19, 2025

Roll Flutter from 9a78af5eb067 to 80f5de5da95d (38 revisions) flutter/packages#9292

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

6265349

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 20, 2025

Roll Flutter from 9a78af5eb067 to c04cd2b18ebf (46 revisions) flutter/packages#9294

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

9718912

…comments (flutter/flutter#168498)

engine-flutter-autoroll mentioned this pull request May 20, 2025

Roll Flutter from 9a78af5eb067 to c04cd2b18ebf (46 revisions) flutter/packages#9296

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

75575e7

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

0c974dd

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

6ab09bf

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

16d0fa6

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

fb33564

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

a53435f

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

f0dc128

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

950aa1c

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

5ef004f

…comments (flutter/flutter#168498)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

77ba01576 [tool] Fix broken comment references and code spans in doc …

0ffdbb6

…comments (flutter/flutter#168498)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[tool] Fix broken comment references and code spans in doc comments #168498

[tool] Fix broken comment references and code spans in doc comments #168498

Uh oh!

parlough commented May 7, 2025 •

edited

Loading

Uh oh!

LouiseHsu left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[tool] Fix broken comment references and code spans in doc comments #168498

[tool] Fix broken comment references and code spans in doc comments #168498

Uh oh!

Conversation

parlough commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

LouiseHsu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

parlough commented May 7, 2025 •

edited

Loading