Skip to content

Update flutter to dartdoc 6.3.0 and hide Icons implementation from doc pages - #128442

Merged
auto-submit[bot] merged 5 commits into
flutter:masterfrom
jcollins-g:dartdoc-6.3.0
Jun 8, 2023
Merged

Update flutter to dartdoc 6.3.0 and hide Icons implementation from doc pages#128442
auto-submit[bot] merged 5 commits into
flutter:masterfrom
jcollins-g:dartdoc-6.3.0

Conversation

@jcollins-g

@jcollins-g jcollins-g commented Jun 7, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

This updates dartdoc to 6.3.0. Release notes are available, here:

https://github.com/dart-lang/dartdoc/releases/tag/v6.3.0

Most important for Flutter are the reduction in the size of generated HTML files (dart-lang/dartdoc#3384) and a new dartdoc directive to hide constant implementations from indicated classes (dart-lang/dartdoc#3398), which fixes the longstanding issue (dart-lang/dartdoc#2657).

I've also added the api documentation zip to .gitignore and the {@hideConstantImplementations} dartdoc directive to the motivating example. A screenshot:

Screenshot 2023-06-07 at 9 54 58 AM

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 assert that this change to icons.dart should be test-exempt as existing tests cover whether or not dartdoc directives are recognized or are leaking into HTML, and the impact of adding the directive was tested in dart-lang/dartdoc#3398.

  • All existing and new tests are passing.

@github-actions github-actions Bot added p: material_ui material_ui package in flutter/packages framework flutter/packages/flutter repository. See also f: labels. c: contributor-productivity Team-specific productivity, code health, technical debt. labels Jun 7, 2023
guidezpl
guidezpl approved these changes Jun 7, 2023
View reviewed changes

@guidezpl guidezpl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I'll close #128235.

Don't forget cupertino/icons.dart

@jcollins-g

jcollins-g commented Jun 7, 2023

Copy link
Copy Markdown
Contributor Author

@guidezpl Would you like me to add that to this PR or do a follow up?

@guidezpl

guidezpl commented Jun 7, 2023

Copy link
Copy Markdown
Member

It can be added here, np.

@github-actions github-actions Bot added the p: cupertino_ui cupertino_ui package in flutter/packages label Jun 7, 2023
@jcollins-g jcollins-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 7, 2023
@auto-submit auto-submit Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 8, 2023
@auto-submit

auto-submit Bot commented Jun 8, 2023

Copy link
Copy Markdown
Contributor

auto label is removed for flutter/flutter, pr: 128442, due to - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

@jcollins-g jcollins-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 8, 2023
@auto-submit
auto-submit Bot merged commit 29c858a into flutter:master Jun 8, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 9, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jun 9, 2023
@engine-flutter-autoroll
29c858a Update flutter to dartdoc 6.3.0 and hide Icons implementation…
94085bf 
… from doc pages (flutter/flutter#128442)
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request Jun 9, 2023
@engine-flutter-autoroll
Roll Flutter from 6e254a3 to da127f1 (28 revisions) (#4170)
914d120 
flutter/flutter@6e254a3...da127f1

2023-06-09 [email protected] Updated material button theme tests for Material3 (flutter/flutter#128543)
2023-06-09 [email protected] Roll Flutter Engine from cb93477008d6 to 93afba901b3b (2 revisions) (flutter/flutter#128573)
2023-06-09 [email protected] Improve defaults generation with logging, stats, and token validation (flutter/flutter#128244)
2023-06-09 [email protected] [testing] Make the FLUTTER_STORAGE_BASE_URL warning non-fatal (flutter/flutter#128335)
2023-06-09 [email protected] [flutter_tools] [DAP] Don't try to restart/reload if app hasn't started yet (flutter/flutter#128267)
2023-06-09 [email protected] Roll Flutter Engine from 8f9e608d39ab to cb93477008d6 (3 revisions) (flutter/flutter#128568)
2023-06-09 [email protected] Replace `MaterialButton` from test classes (flutter/flutter#128466)
2023-06-09 [email protected] Fix `showBottomSheet` doesn't remove scrim when draggable sheet is dismissed (flutter/flutter#128455)
2023-06-09 [email protected] Manual roll Flutter Engine from a5f7d5d75ff2 to 8f9e608d39ab (31 revisions) (flutter/flutter#128554)
2023-06-09 [email protected] Revert "test owners: cyanglaz -> vashworth" (flutter/flutter#128462)
2023-06-09 [email protected] [Android] Bump integration tests using `compileSdkVersion` 31 to 33 (flutter/flutter#128072)
2023-06-09 [email protected] Remove single view assumption from MouseTracker, and unify its hit testing code flow (flutter/flutter#127060)
2023-06-09 [email protected] [flutter_tools] Precache after channel switch (flutter/flutter#118129)
2023-06-08 [email protected] Adding migration guide for Material 3 colors (flutter/flutter#128429)
2023-06-08 [email protected] Add `AppLifecycleListener`, with support for application exit handling (flutter/flutter#123274)
2023-06-08 [email protected] Sliver Main Axis Group (flutter/flutter#126596)
2023-06-08 [email protected] Reduce `_DoubleClampVisitor` false positives (flutter/flutter#128539)
2023-06-08 [email protected] Advise developers to use OverflowBar instead of ButtonBar (flutter/flutter#128437)
2023-06-08 [email protected] Reland "Migrate benchmarks to package:web" (flutter/flutter#128266)
2023-06-08 [email protected] Navigator.pop before PopupMenuItem onTap call (flutter/flutter#127446)
2023-06-08 [email protected] Fix navigation rail with long labels misplaced highlights (flutter/flutter#128324)
2023-06-08 [email protected] Update `chip.dart` to use set of `MaterialState` (flutter/flutter#128507)
2023-06-08 [email protected] Update flutter to dartdoc 6.3.0 and hide Icons implementation from doc pages (flutter/flutter#128442)
2023-06-08 [email protected] Disable blinking cursor when `EditableText.showCursor` is false (flutter/flutter#127562)
2023-06-08 [email protected] [floating_cursor_selection]add more comments on the tricky part (flutter/flutter#127227)
2023-06-08 [email protected] Move RenderObjectElement.updateChildren to Element (flutter/flutter#128458)
2023-06-08 [email protected] Fix PointerEventConverter doc (flutter/flutter#128452)
2023-06-08 [email protected] Roll Packages from a84b2c2 to e13b8c4 (9 revisions) (flutter/flutter#128508)

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 [email protected],[email protected] 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@jcollins-g
jcollins-g deleted the dartdoc-6.3.0 branch June 9, 2023 16:19
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2023
@engine-flutter-autoroll
29c858a Update flutter to dartdoc 6.3.0 and hide Icons implementation…
b3572f5 
… from doc pages (flutter/flutter#128442)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
29c858a Update flutter to dartdoc 6.3.0 and hide Icons implementation…
8045e1e 
… from doc pages (flutter/flutter#128442)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
29c858a Update flutter to dartdoc 6.3.0 and hide Icons implementation…
97ab820 
… from doc pages (flutter/flutter#128442)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 17, 2023
@engine-flutter-autoroll
29c858a Update flutter to dartdoc 6.3.0 and hide Icons implementation…
30c7813 
… from doc pages (flutter/flutter#128442)
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@engine-flutter-autoroll
Roll Flutter from 6e254a3 to da127f1 (28 revisions) (flutter#4170)
bb345b5 
flutter/flutter@6e254a3...da127f1

2023-06-09 [email protected] Updated material button theme tests for Material3 (flutter/flutter#128543)
2023-06-09 [email protected] Roll Flutter Engine from cb93477008d6 to 93afba901b3b (2 revisions) (flutter/flutter#128573)
2023-06-09 [email protected] Improve defaults generation with logging, stats, and token validation (flutter/flutter#128244)
2023-06-09 [email protected] [testing] Make the FLUTTER_STORAGE_BASE_URL warning non-fatal (flutter/flutter#128335)
2023-06-09 [email protected] [flutter_tools] [DAP] Don't try to restart/reload if app hasn't started yet (flutter/flutter#128267)
2023-06-09 [email protected] Roll Flutter Engine from 8f9e608d39ab to cb93477008d6 (3 revisions) (flutter/flutter#128568)
2023-06-09 [email protected] Replace `MaterialButton` from test classes (flutter/flutter#128466)
2023-06-09 [email protected] Fix `showBottomSheet` doesn't remove scrim when draggable sheet is dismissed (flutter/flutter#128455)
2023-06-09 [email protected] Manual roll Flutter Engine from a5f7d5d75ff2 to 8f9e608d39ab (31 revisions) (flutter/flutter#128554)
2023-06-09 [email protected] Revert "test owners: cyanglaz -> vashworth" (flutter/flutter#128462)
2023-06-09 [email protected] [Android] Bump integration tests using `compileSdkVersion` 31 to 33 (flutter/flutter#128072)
2023-06-09 [email protected] Remove single view assumption from MouseTracker, and unify its hit testing code flow (flutter/flutter#127060)
2023-06-09 [email protected] [flutter_tools] Precache after channel switch (flutter/flutter#118129)
2023-06-08 [email protected] Adding migration guide for Material 3 colors (flutter/flutter#128429)
2023-06-08 [email protected] Add `AppLifecycleListener`, with support for application exit handling (flutter/flutter#123274)
2023-06-08 [email protected] Sliver Main Axis Group (flutter/flutter#126596)
2023-06-08 [email protected] Reduce `_DoubleClampVisitor` false positives (flutter/flutter#128539)
2023-06-08 [email protected] Advise developers to use OverflowBar instead of ButtonBar (flutter/flutter#128437)
2023-06-08 [email protected] Reland "Migrate benchmarks to package:web" (flutter/flutter#128266)
2023-06-08 [email protected] Navigator.pop before PopupMenuItem onTap call (flutter/flutter#127446)
2023-06-08 [email protected] Fix navigation rail with long labels misplaced highlights (flutter/flutter#128324)
2023-06-08 [email protected] Update `chip.dart` to use set of `MaterialState` (flutter/flutter#128507)
2023-06-08 [email protected] Update flutter to dartdoc 6.3.0 and hide Icons implementation from doc pages (flutter/flutter#128442)
2023-06-08 [email protected] Disable blinking cursor when `EditableText.showCursor` is false (flutter/flutter#127562)
2023-06-08 [email protected] [floating_cursor_selection]add more comments on the tricky part (flutter/flutter#127227)
2023-06-08 [email protected] Move RenderObjectElement.updateChildren to Element (flutter/flutter#128458)
2023-06-08 [email protected] Fix PointerEventConverter doc (flutter/flutter#128452)
2023-06-08 [email protected] Roll Packages from a84b2c2 to e13b8c4 (9 revisions) (flutter/flutter#128508)

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 [email protected],[email protected] 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
@engine-flutter-autoroll
Roll Flutter from 6e254a3 to da127f1 (28 revisions) (flutter#4170)
65584d1 
flutter/flutter@6e254a3...da127f1

2023-06-09 [email protected] Updated material button theme tests for Material3 (flutter/flutter#128543)
2023-06-09 [email protected] Roll Flutter Engine from cb93477008d6 to 93afba901b3b (2 revisions) (flutter/flutter#128573)
2023-06-09 [email protected] Improve defaults generation with logging, stats, and token validation (flutter/flutter#128244)
2023-06-09 [email protected] [testing] Make the FLUTTER_STORAGE_BASE_URL warning non-fatal (flutter/flutter#128335)
2023-06-09 [email protected] [flutter_tools] [DAP] Don't try to restart/reload if app hasn't started yet (flutter/flutter#128267)
2023-06-09 [email protected] Roll Flutter Engine from 8f9e608d39ab to cb93477008d6 (3 revisions) (flutter/flutter#128568)
2023-06-09 [email protected] Replace `MaterialButton` from test classes (flutter/flutter#128466)
2023-06-09 [email protected] Fix `showBottomSheet` doesn't remove scrim when draggable sheet is dismissed (flutter/flutter#128455)
2023-06-09 [email protected] Manual roll Flutter Engine from a5f7d5d75ff2 to 8f9e608d39ab (31 revisions) (flutter/flutter#128554)
2023-06-09 [email protected] Revert "test owners: cyanglaz -> vashworth" (flutter/flutter#128462)
2023-06-09 [email protected] [Android] Bump integration tests using `compileSdkVersion` 31 to 33 (flutter/flutter#128072)
2023-06-09 [email protected] Remove single view assumption from MouseTracker, and unify its hit testing code flow (flutter/flutter#127060)
2023-06-09 [email protected] [flutter_tools] Precache after channel switch (flutter/flutter#118129)
2023-06-08 [email protected] Adding migration guide for Material 3 colors (flutter/flutter#128429)
2023-06-08 [email protected] Add `AppLifecycleListener`, with support for application exit handling (flutter/flutter#123274)
2023-06-08 [email protected] Sliver Main Axis Group (flutter/flutter#126596)
2023-06-08 [email protected] Reduce `_DoubleClampVisitor` false positives (flutter/flutter#128539)
2023-06-08 [email protected] Advise developers to use OverflowBar instead of ButtonBar (flutter/flutter#128437)
2023-06-08 [email protected] Reland "Migrate benchmarks to package:web" (flutter/flutter#128266)
2023-06-08 [email protected] Navigator.pop before PopupMenuItem onTap call (flutter/flutter#127446)
2023-06-08 [email protected] Fix navigation rail with long labels misplaced highlights (flutter/flutter#128324)
2023-06-08 [email protected] Update `chip.dart` to use set of `MaterialState` (flutter/flutter#128507)
2023-06-08 [email protected] Update flutter to dartdoc 6.3.0 and hide Icons implementation from doc pages (flutter/flutter#128442)
2023-06-08 [email protected] Disable blinking cursor when `EditableText.showCursor` is false (flutter/flutter#127562)
2023-06-08 [email protected] [floating_cursor_selection]add more comments on the tricky part (flutter/flutter#127227)
2023-06-08 [email protected] Move RenderObjectElement.updateChildren to Element (flutter/flutter#128458)
2023-06-08 [email protected] Fix PointerEventConverter doc (flutter/flutter#128452)
2023-06-08 [email protected] Roll Packages from ac06bf0 to 2c49d34 (9 revisions) (flutter/flutter#128508)

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 [email protected],[email protected] 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@guidezpl guidezpl guidezpl approved these changes

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. p: cupertino_ui cupertino_ui package in flutter/packages p: material_ui material_ui package in flutter/packages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jcollins-g @guidezpl