-
Notifications
You must be signed in to change notification settings - Fork 3.8k
[cupertino_ui, material_ui] Fix bad doc references #12381
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| changelog: | | ||
| - Remove unresolvable doc import for flutter_test | ||
| version: patch |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,6 @@ | |
| /// for a catalog of commonly-used Material component widgets. | ||
| /// * [m3.material.io](https://m3.material.io/) for the Material 3 specification | ||
| /// * [m2.material.io](https://m2.material.io/) for the Material 2 specification | ||
| /// @docImport 'package:flutter_test/flutter_test.dart'; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We thought this could fix some references coming from the widgets library as it is re-exported (for now) from these packages. Since flutter_test is only a dev dependency, doc import will not work. |
||
| /// @docImport 'package:intl/intl.dart'; | ||
| library material_ui; | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,6 @@ | |
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| /// @docImport 'package:intl/intl.dart'; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since package:intl is imported with a prefix This was the cause of the bulk of the 1,400 doc reference issues we are seeing on pub. The same was not true of cupertino_ui, turns out cupertino_ui does not even make the below references - because it is actually incorrect! So, I just removed them. |
||
| library; | ||
|
|
||
| import 'package:cupertino_ui/cupertino_ui.dart' show GlobalCupertinoLocalizations; | ||
| import 'package:flutter/foundation.dart'; | ||
| import 'package:flutter/widgets.dart'; | ||
|
|
@@ -314,7 +311,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleOne], the "one" form | ||
| /// * [selectedRowCountTitleTwo], the "two" form | ||
| /// * [selectedRowCountTitleFew], the "few" form | ||
|
|
@@ -329,7 +325,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleZero], the "zero" form | ||
| /// * [selectedRowCountTitleTwo], the "two" form | ||
| /// * [selectedRowCountTitleFew], the "few" form | ||
|
|
@@ -344,7 +339,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleZero], the "zero" form | ||
| /// * [selectedRowCountTitleOne], the "one" form | ||
| /// * [selectedRowCountTitleFew], the "few" form | ||
|
|
@@ -359,7 +353,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleZero], the "zero" form | ||
| /// * [selectedRowCountTitleOne], the "one" form | ||
| /// * [selectedRowCountTitleTwo], the "two" form | ||
|
|
@@ -374,7 +367,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleZero], the "zero" form | ||
| /// * [selectedRowCountTitleOne], the "one" form | ||
| /// * [selectedRowCountTitleTwo], the "two" form | ||
|
|
@@ -389,7 +381,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [selectedRowCountTitleZero], the "zero" form | ||
| /// * [selectedRowCountTitleOne], the "one" form | ||
| /// * [selectedRowCountTitleTwo], the "two" form | ||
|
|
@@ -446,7 +437,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [licensesPackageDetailTextZero], the "zero" form | ||
| /// * [licensesPackageDetailTextOne], the "one" form | ||
| /// * [licensesPackageDetailTextTwo], the "two" form | ||
|
|
@@ -477,7 +467,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [licensesPackageDetailTextZero], the "zero" form | ||
| /// * [licensesPackageDetailTextOne], the "one" form | ||
| /// * [licensesPackageDetailTextTwo], the "two" form | ||
|
|
@@ -493,7 +482,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [licensesPackageDetailTextZero], the "zero" form | ||
| /// * [licensesPackageDetailTextOne], the "one" form | ||
| /// * [licensesPackageDetailTextTwo], the "two" form | ||
|
|
@@ -509,7 +497,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [licensesPackageDetailTextZero], the "zero" form | ||
| /// * [licensesPackageDetailTextOne], the "one" form | ||
| /// * [licensesPackageDetailTextTwo], the "two" form | ||
|
|
@@ -525,7 +512,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [licensesPackageDetailTextZero], the "zero" form | ||
| /// * [licensesPackageDetailTextOne], the "one" form | ||
| /// * [licensesPackageDetailTextTwo], the "two" form | ||
|
|
@@ -555,7 +541,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [remainingTextFieldCharacterCountZero], the "zero" form | ||
| /// * [remainingTextFieldCharacterCountOne], the "one" form | ||
| /// * [remainingTextFieldCharacterCountTwo], the "two" form | ||
|
|
@@ -586,7 +571,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [remainingTextFieldCharacterCountZero], the "zero" form | ||
| /// * [remainingTextFieldCharacterCountOne], the "one" form | ||
| /// * [remainingTextFieldCharacterCountTwo], the "two" form | ||
|
|
@@ -602,7 +586,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [remainingTextFieldCharacterCountZero], the "zero" form | ||
| /// * [remainingTextFieldCharacterCountOne], the "one" form | ||
| /// * [remainingTextFieldCharacterCountTwo], the "two" form | ||
|
|
@@ -618,7 +601,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [remainingTextFieldCharacterCountZero], the "zero" form | ||
| /// * [remainingTextFieldCharacterCountOne], the "one" form | ||
| /// * [remainingTextFieldCharacterCountTwo], the "two" form | ||
|
|
@@ -634,7 +616,6 @@ abstract class GlobalMaterialLocalizations implements MaterialLocalizations { | |
| /// | ||
| /// See also: | ||
| /// | ||
| /// * [Intl.plural], to which this form is passed. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above. |
||
| /// * [remainingTextFieldCharacterCountZero], the "zero" form | ||
| /// * [remainingTextFieldCharacterCountOne], the "one" form | ||
| /// * [remainingTextFieldCharacterCountTwo], the "two" form | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,6 @@ | |
| // To regenerate the file, use: | ||
| // dart script/l10n/bin/gen_localizations.dart --overwrite | ||
|
|
||
| /// @docImport 'package:intl/intl.dart'; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are no references to intl in this file, and they would need the intl prefix as it is imported below anyways. removed since it is not needed. |
||
| library; | ||
|
|
||
| import 'dart:collection'; | ||
|
|
||
| import 'package:flutter/widgets.dart'; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -327,7 +327,38 @@ class PaginatedDataTable extends StatefulWidget { | |
| /// {@macro flutter.widgets.scroll_view.controller} | ||
| final ScrollController? controller; | ||
|
|
||
| /// {@macro flutter.widgets.scroll_view.primary} | ||
| /// {@template material_ui.paginated_data_table.primary} | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixes references to TargetPlatformVariant coming from widgets.dart, which cannot resolve in the dart docs for this package. |
||
| /// Whether this is the primary scroll view associated with the parent | ||
| /// [PrimaryScrollController]. | ||
| /// | ||
| /// When this is true, the scroll view is scrollable even if it does not have | ||
| /// sufficient content to actually scroll. Otherwise, by default the user can | ||
| /// only scroll the view if it has sufficient content. See [physics]. | ||
| /// | ||
| /// Also when true, the scroll view is used for default [ScrollAction]s. If a | ||
| /// ScrollAction is not handled by an otherwise focused part of the application, | ||
| /// the ScrollAction will be evaluated using this scroll view, for example, | ||
| /// when executing [Shortcuts] key events like page up and down. | ||
| /// | ||
| /// On iOS, this also identifies the scroll view that will scroll to top in | ||
| /// response to a tap in the status bar. | ||
| /// | ||
| /// Cannot be true while a [ScrollController] is provided to `controller`, | ||
| /// only one ScrollController can be associated with a ScrollView. | ||
| /// | ||
| /// Setting to false will explicitly prevent inheriting any | ||
| /// [PrimaryScrollController]. | ||
| /// | ||
| /// Defaults to null. When null, and a controller is not provided, | ||
| /// [PrimaryScrollController.shouldInherit] is used to decide automatic | ||
| /// inheritance. | ||
| /// | ||
| /// By default, the [PrimaryScrollController] that is injected by each | ||
| /// [ModalRoute] is configured to automatically be inherited on | ||
| /// mobile platforms for ScrollViews in the [Axis.vertical] | ||
| /// scroll direction. Adding another to your app will override the | ||
| /// PrimaryScrollController above it. | ||
| /// {@endtemplate} | ||
| final bool? primary; | ||
|
|
||
| /// {@macro material_ui.dataTable.headingRowColor} | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,8 @@ | |
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| /// @docImport 'package:flutter_test/flutter_test.dart'; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cannot resolve in this package. |
||
| /// | ||
| /// @docImport 'card.dart'; | ||
| /// @docImport 'paginated_data_table.dart'; | ||
| library; | ||
|
Piinks marked this conversation as resolved.
|
||
|
|
||
| import 'dart:ui' show lerpDouble; | ||
|
|
@@ -37,9 +36,9 @@ import 'theme.dart'; | |
| /// | ||
| /// </callout-box> | ||
| /// | ||
| /// By default, on [TargetPlatformVariant.desktop] platforms each item will | ||
| /// By default, on desktop platforms each item will | ||
| /// have a drag handle added on top of it that will allow the user to grab it | ||
| /// to move the item. On [TargetPlatformVariant.mobile], no drag handle will be | ||
|
Comment on lines
-40
to
-42
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above, since these come from flutter_test and flutter_test references cannot be resolved since they are not a direct dev dependency, removed. |
||
| /// to move the item. On mobile platforms, no drag handle will be | ||
| /// added, but when the user long presses anywhere on the item it will start | ||
| /// moving the item. Displaying drag handles can be controlled with | ||
| /// [ReorderableListView.buildDefaultDragHandles]. | ||
|
|
@@ -321,8 +320,8 @@ class ReorderableListView extends StatefulWidget { | |
| /// {@macro flutter.widgets.scroll_view.controller} | ||
| final ScrollController? scrollController; | ||
|
|
||
| /// {@macro flutter.widgets.scroll_view.primary} | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated for new macro that removes references to TargetPlatformVariant |
||
|
|
||
| /// {@macro material_ui.paginated_data_table.primary} | ||
| /// | ||
| /// Defaults to true when [scrollDirection] is [Axis.vertical] and | ||
| /// [scrollController] is null. | ||
| final bool? primary; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| changelog: | | ||
| - Replace unresolvable doc imports | ||
| version: patch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We thought this could fix some references coming from the widgets library as it is re-exported (for now) from these packages. Since flutter_test is only a dev dependency, doc import will not work.