Repository navigation
Commit 0feeeab
authored
This PR moves API examples from `<root>/examples/api` to
`<root>/packages/flutter/examples/api`.
This change is required because the standard dartdoc directive
`{@example}` requires API examples to reside within the package
directory. For more details, see issue
flutter#189629 (item 1 under "What's
needed").
### Summary of changes
Moved all API example files to `packages/flutter/examples/api`.
Updated related scripts and CI configurations to reflect the new
directory structure.
- Most changes involve simple path updates from `examples/api` to
`packages/flutter/examples/api`.
- Some adjustments were more complex because the examples, which
previously resided in a single `<root>/examples` directory, are now
split across two separate locations.
Existing paths in `"See code in "` directives are retained. These paths
are now treated as relative to the package root rather than the
repository root. For example, the following API doc comment remains
valid despite the file move:
```dart
/// Class definition.
///
/// {@tool sample}
/// An example.
///
/// ** See code in examples/api/lib/widgets/foo/foo.0.dart **
/// {@end-tool}
```
Three API doc tests are now marked as `reduced-test-set` because they're
now facing additional analysis for being under `packages/flutter`.
## Pre-launch 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] 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.
If you need help, consider asking for advice on the #hackers-new channel
on [Discord].
If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.
**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
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.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent dba040a commit 0feeeab
1,239 files changed
Lines changed: 761 additions & 647 deletions
File tree
- .github
- workflows
- dev
- bots
- suite_runners
- test
- analyze-test-input
- snippets
- lib/src
- test
- tools
- docs/contributing
- packages/flutter/examples/api
- lib
- animation
- animation_controller
- curves
- cupertino
- activity_indicator
- bottom_tab_bar
- button
- checkbox
- date_picker
- dialog
- expansion_tile
- form_row
- list_section
- list_tile
- magnifier
- page_scaffold
- picker
- radio
- refresh
- route
- scrollbar
- search_field
- segmented_control
- sheet
- slider
- switch
- tab_scaffold
- text_field
- text_form_field_row
- foundation/key
- gestures
- pointer_signal_resolver
- tap_and_drag
- material
- about
- action_buttons
- action_chip
- animated_icon
- app_bar
- app
- autocomplete
- badge
- banner
- bottom_app_bar
- bottom_sheet
- button_style
- card
- carousel
- checkbox_list_tile
- checkbox
- chip
- choice_chip
- color_scheme
- data_table
- date_picker
- dialog
- divider
- drawer
- dropdown
- elevated_button
- expansion_panel
- expansion_tile
- filled_button
- filter_chip
- flexible_space_bar
- floating_action_button_location
- floating_action_button
- icon_alignment
- icon_button
- ink_well
- ink
- input_chip
- input_decorator
- list_tile
- material_state
- outlined_button
- page_transitions_theme
- paginated_data_table
- progress_indicator
- radio_list_tile
- radio
- range_slider
- refresh_indicator
- reorderable_list
- scaffold
- scrollbar
- search_anchor
- segmented_button
- selection_area
- shaped_input_border
- slider
- snack_bar
- stepper
- switch_list_tile
- switch
- tab_controller
- tabs
- text_button
- text_field
- text_form_field
- theme_data
- theme
- time_picker
- toggle_buttons
- tooltip
- widget_state_input_border
- painting
- axis_direction
- borders
- gradient
- image_provider
- linear_border
- rounded_superellipse_border
- star_border
- rendering
- box
- growth_direction
- scroll_direction
- sliver_grid
- sample_templates
- services
- binding
- keyboard_key
- mouse_cursor
- system_chrome
- text_input
- ui/text
- widgets
- actions
- animated_grid
- animated_list
- animated_size
- animated_switcher
- app_lifecycle_listener
- app
- async
- autocomplete
- autofill
- basic
- binding
- color_filter
- dismissible
- drag_target
- draggable_scrollable_sheet
- editable_text
- expansible
- focus_manager
- focus_scope
- focus_traversal
- form
- framework
- gesture_detector
- hardware_keyboard
- heroes
- image
- implicit_animations
- inherited_model
- inherited_notifier
- inherited_theme
- interactive_viewer
- keep_alive
- layout_builder
- magnifier
- media_query
- nested_scroll_view
- notification_listener
- overflow_bar
- overlay
- overscroll_indicator
- page_storage
- page_transitions_builder
- page_view
- page
- pop_scope
- preferred_size
- radio_group
- raw_tooltip
- repeating_animation_builder
- restoration_properties
- restoration
- routes
- safe_area
- scroll_end_notification
- scroll_notification_observer
- scroll_position
- scroll_view
- scrollbar
- selectable_region
- selection_container
- sensitive_content
- shortcuts
- single_child_scroll_view
- sliver_fill
- sliver
- slotted_render_object_widget
- table
- tap_region
- text_editing_intents
- text_magnifier
- text
- transitions
- tween_animation_builder
- undo_history
- value_listenable_builder
- widget_state
- windows
- linux
- flutter
- runner
- macos
- Flutter
- Runner.xcodeproj
- Runner.xcworkspace
- Runner
- Assets.xcassets/AppIcon.appiconset
- Base.lproj
- Configs
- test_driver
- test
- animation
- animation_controller
- curves
- cupertino
- activity_indicator
- bottom_tab_bar
- button
- checkbox
- date_picker
- dialog
- expansion_tile
- form_row
- list_section
- list_tile
- magnifier
- page_scaffold
- picker
- radio
- refresh
- route
- scrollbar
- search_field
- segmented_control
- sheet
- slider
- switch
- tab_scaffold
- text_field
- text_form_field_row
- foundation/key
- gestures
- pointer_signal_resolver
- tap_and_drag
- material
- about
- action_buttons
- action_chip
- animated_icon
- app_bar
- app
- autocomplete
- badge
- banner
- bottom_app_bar
- bottom_sheet
- button_style
- card
- carousel
- checkbox_list_tile
- checkbox
- chip
- choice_chip
- color_scheme
- data_table
- date_picker
- dialog
- divider
- drawer
- dropdown
- elevated_button
- expansion_panel
- expansion_tile
- filled_button
- filter_chip
- flexible_space_bar
- floating_action_button_location
- floating_action_button
- icon_alignment
- icon_button
- ink_well
- ink
- input_chip
- input_decorator
- list_tile
- material_state
- outlined_button
- page_transitions_theme
- paginated_data_table
- progress_indicator
- radio_list_tile
- radio
- range_slider
- refresh_indicator
- reorderable_list
- scaffold
- scrollbar
- search_anchor
- segmented_button
- selection_area
- shaped_input_border
- slider
- snack_bar
- stepper
- switch_list_tile
- switch
- tab_controller
- tabs
- text_button
- text_field
- text_form_field
- theme_data
- theme
- time_picker
- toggle_buttons
- tooltip
- widget_state_input_border
- painting
- axis_direction
- borders
- gradient
- image_provider
- linear_border
- rounded_superellipse_border
- star_border
- rendering
- box
- growth_direction
- scroll_direction
- sliver_grid
- sample_templates
- services
- binding
- keyboard_key
- mouse_cursor
- system_chrome
- text_input
- ui/text
- widgets
- actions
- animated_grid
- animated_list
- animated_size
- animated_switcher
- app_lifecycle_listener
- app
- async
- autocomplete
- autofill
- basic
- binding
- color_filter
- dismissible
- drag_target
- draggable_scrollable_sheet
- editable_text
- expansible
- focus_manager
- focus_scope
- focus_traversal
- form
- framework
- gesture_detector
- hardware_keyboard
- heroes
- image
- implicit_animations
- inherited_model
- inherited_notifier
- inherited_theme
- interactive_viewer
- keep_alive
- layout_builder
- magnifier
- media_query
- nested_scroll_view
- notification_listener
- overflow_bar
- overlay
- overscroll_indicator
- page_storage
- page_transitions_builder
- page_view
- page
- pop_scope
- preferred_size
- radio_group
- raw_tooltip
- repeating_animation_builder
- restoration_properties
- restoration
- routes
- safe_area
- scroll_end_notification
- scroll_notification_observer
- scroll_position
- scroll_view
- scrollbar
- selectable_region
- selection_container
- sensitive_content
- shortcuts
- single_child_scroll_view
- sliver_fill
- sliver
- slotted_render_object_widget
- table
- tap_region
- text_editing_intents
- text_magnifier
- text
- transitions
- tween_animation_builder
- undo_history
- value_listenable_builder
- widget_state
- windows
- web
- icons
- windows
- flutter
- runner
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| 64 | + | |
64 | 65 | | |
65 | 66 | | |
66 | 67 | | |
| |||
138 | 139 | | |
139 | 140 | | |
140 | 141 | | |
141 | | - | |
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
35 | 39 | | |
36 | 40 | | |
37 | 41 | | |
38 | 42 | | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
225 | 225 | | |
226 | 226 | | |
227 | 227 | | |
228 | | - | |
| 228 | + | |
229 | 229 | | |
230 | 230 | | |
231 | 231 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
11 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
| |||
1008 | 1009 | | |
1009 | 1010 | | |
1010 | 1011 | | |
1011 | | - | |
| 1012 | + | |
1012 | 1013 | | |
1013 | 1014 | | |
1014 | 1015 | | |
1015 | | - | |
| 1016 | + | |
1016 | 1017 | | |
1017 | | - | |
| 1018 | + | |
1018 | 1019 | | |
1019 | 1020 | | |
1020 | 1021 | | |
| |||
1028 | 1029 | | |
1029 | 1030 | | |
1030 | 1031 | | |
1031 | | - | |
| 1032 | + | |
1032 | 1033 | | |
1033 | 1034 | | |
1034 | 1035 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
20 | 26 | | |
21 | 27 | | |
22 | 28 | | |
| |||
128 | 134 | | |
129 | 135 | | |
130 | 136 | | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
131 | 141 | | |
132 | 142 | | |
133 | 143 | | |
| |||
258 | 268 | | |
259 | 269 | | |
260 | 270 | | |
261 | | - | |
| 271 | + | |
262 | 272 | | |
263 | 273 | | |
264 | 274 | | |
| |||
0 commit comments