[material_ui] Migrate api sample code to @example dartdoc directive

[dkwingsmt]

Migrates @tool directives to @example in material_ui
Towards flutter/flutter#172936 and flutter/flutter#172937

Prerequisite:

• [material_ui] Move over more API samples #12092, which moves missing sample files.

Related:

• [cupertino_ui] Migrate api sample code to @example dartdoc directive #12063, which migrates cupertino_ui

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the AI contribution guidelines and understand my responsibilities, or I am not using AI tools.
• I read the Tree Hygiene page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter.
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style, or I have commented below to indicate which documented exception this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under¹.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩²

[gemini-code-assist]

Code Review

This pull request replaces {@tool dartpad} and {@tool snippet} documentation blocks across numerous Material UI source files with TODO comments referencing tracking issues for future @dartpad directive and blue example container support. Additionally, a comment was removed from the example's analysis_options.yaml file. There are no review comments, and I have no feedback to provide.

[gemini-code-assist]

Code Review

This pull request migrates documentation examples and Dartpad tool blocks across various Material UI files to use the {@example} directive or adds TODO comments to replace them once supported. The reviewer identified two instances in app_bar.dart and material_state.dart where references to example files were missed during the migration and should be updated to use the {@example} directive.

[gemini-code-assist]

This reference to sliver_app_bar.4.dart was missed during the migration to the {@example} directive. It should be updated to use the {@example} directive with the correct path.

/// {@example /example/lib/app_bar/sliver_app_bar.4.dart}

[Piinks]

++
Maybe a quick search of "See code in" and "@tool" will catch any others?

[gemini-code-assist]

This reference to widget_state_outlined_border.0.dart was missed during the migration to the {@example} directive. It should be updated to use the {@example} directive with the correct path.

/// {@example /example/lib/widgets/widget_state/widget_state_outlined_border.0.dart}

[Piinks]

The analyzer failure is just the @example directive not being recognized, so it just needs that override from the sample PR. 👍

[justinmc]

LGTM 👍

[fluttergithubbot]

An existing Git SHA, 9e39f7a9c394781774e62878daeaad39030905f2, was detected, and no actions were taken.

To re-trigger presubmits after closing or re-opeing a PR, or pushing a HEAD commit (i.e. with --force) that already was pushed before, push a blank commit (git commit --allow-empty -m "Trigger Build") or rebase to continue.

[Piinks]

#12063 landed with the @example mitigation for the analyzer. Rebasing should pick it up here and this should be good to go!