Skip to content

[material_ui, cupertino_ui] Migrate several doc directives for demonstration #11975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dkwingsmt wants to merge 3 commits into from
+30 −11
Closed

[material_ui, cupertino_ui] Migrate several doc directives for demonstration #11975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed40e72
Impl
dkwingsmt Jun 24, 2026
a3ff59e
Add analyzer ignore
dkwingsmt Jun 24, 2026
ef185bc
Remove space
dkwingsmt Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ analyzer:
# something (https://github.com/flutter/flutter/issues/143312)
deprecated_member_use: ignore
deprecated_member_use_from_same_package: ignore
# `dart analyze` hasn't recognized this new directive yet.
# Remove it once https://github.com/dart-lang/sdk/pull/63646 is landed.
doc_directive_unknown: ignore
exclude: # DIFFERENT FROM FLUTTER/FLUTTER
# Ignore generated files
- '**/*.pb.dart'
Expand Down
18 changes: 12 additions & 6 deletions packages/cupertino_ui/lib/src/menu_anchor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,19 +295,25 @@ typedef CupertinoMenuAnimationStatusChangedCallback = void Function(AnimationSta
/// invoked every time the [AnimationStatus] of the menu animation changes.
///
/// ## Usage
/// {@tool sample}
// TODO(dkwingsmt): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
///
/// This example demonstrates a simple [CupertinoMenuAnchor] that wraps
/// a button.
///
/// ** See code in examples/api/lib/cupertino/menu_anchor/menu_anchor.0.dart **
/// {@end-tool}
/// {@example /example/lib/menu_anchor/menu_anchor.0.dart}
///
// TODO(dkwingsmt): End of the blue example container.
///
// TODO(dkwingsmt): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
///
/// {@tool dartpad}

@justinmc justinmc Jun 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The dartpads that you have removed appear to now be exactly the same as the samples that you removed (if I'm not overlooking something). Don't you need to distinguish the two so that we can add back the dartpads later?

/// This example demonstrates a [CupertinoMenuAnchor] that wraps a button and
/// shows a menu with three [CupertinoMenuItem]s and one [CupertinoMenuDivider].
///
/// ** See code in examples/api/lib/cupertino/menu_anchor/menu_anchor.1.dart **
/// {@end-tool}
/// {@example /example/lib/menu_anchor/menu_anchor.1.dart}
///
// TODO(dkwingsmt): End of the blue example container.
Comment thread
dkwingsmt marked this conversation as resolved.
///
/// See also:
///
Expand Down
20 changes: 15 additions & 5 deletions packages/material_ui/lib/src/carousel.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ import 'theme.dart';
/// [CarouselView.weighted] is used, then set the [flexWeights] to only have
/// one integer in the array.
///
/// {@tool snippet}
// TODO(dkwingsmt): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
// TODO(dkwingsmt): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
Comment thread
dkwingsmt marked this conversation as resolved.
///
/// This code snippet shows how to get a vertical full-screen carousel by using
/// [itemExtent] in [CarouselView].
Expand Down Expand Up @@ -82,7 +85,8 @@ import 'theme.dart';
/// ),
/// ),
/// ```
/// {@end-tool}
///
// TODO(dkwingsmt): End of the blue example container.
Comment thread
dkwingsmt marked this conversation as resolved.
///
/// In [CarouselView.weighted], weights are relative proportions. For example,
/// if the layout weights is `[3, 2, 1]`, it means the first visible item occupies
Expand All @@ -108,7 +112,9 @@ import 'theme.dart';
/// visible items may be slightly compressed during scrolling. The [shrinkExtent]
/// property controls the minimum allowable size for these compressed items.
///
/// {@tool dartpad}
// TODO(dkwingsmt): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
///
/// Here is an example to show different carousel layouts that [CarouselView]
/// and [CarouselView.weighted] can build.
///
Expand All @@ -120,9 +126,13 @@ import 'theme.dart';
///
/// This key-driven behavior is dictated by the [ScrollBehavior.pointerAxisModifiers],
/// while [ScrollBehavior.dragDevices] manages what devices can drag a scrollable.
//
// TODO(dkwingsmt): Replace the example with a dartpad block when it's
// supported. https://github.com/dart-lang/dartdoc/issues/4123
///
/// {@example /example/lib/carousel/carousel.0.dart}
///
/// ** See code in examples/api/lib/material/carousel/carousel.0.dart **
/// {@end-tool}
// TODO(dkwingsmt): End of the blue example container.
Comment thread
dkwingsmt marked this conversation as resolved.
///
/// See also:
///
Expand Down
Loading