Unverified Commit 179fa904 authored by Greg Spencer's avatar Greg Spencer Committed by GitHub

Fix some doc references (#26441)

parent 9eada88b
...@@ -915,15 +915,15 @@ class _CupertinoDatePickerDateState extends State<CupertinoDatePicker> { ...@@ -915,15 +915,15 @@ class _CupertinoDatePickerDateState extends State<CupertinoDatePicker> {
enum CupertinoTimerPickerMode { enum CupertinoTimerPickerMode {
/// Mode that shows the timer duration in hour and minute. /// Mode that shows the timer duration in hour and minute.
/// ///
/// Examples: [16 hours | 14 min]. /// Examples: 16 hours | 14 min.
hm, hm,
/// Mode that shows the timer duration in minute and second. /// Mode that shows the timer duration in minute and second.
/// ///
/// Examples: [14 min | 43 sec]. /// Examples: 14 min | 43 sec.
ms, ms,
/// Mode that shows the timer duration in hour, minute, and second. /// Mode that shows the timer duration in hour, minute, and second.
/// ///
/// Examples: [16 hours | 14 min | 43 sec]. /// Examples: 16 hours | 14 min | 43 sec.
hms, hms,
} }
......
...@@ -7,24 +7,26 @@ import 'dart:async'; ...@@ -7,24 +7,26 @@ import 'dart:async';
import 'package:flutter/foundation.dart'; import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart'; import 'package:flutter/widgets.dart';
import 'date_picker.dart';
/// Determines the order of the columns inside [CupertinoDatePicker] in /// Determines the order of the columns inside [CupertinoDatePicker] in
/// time and date time mode. /// time and date time mode.
enum DatePickerDateTimeOrder { enum DatePickerDateTimeOrder {
/// Order of the columns, from left to right: date, hour, minute, am/pm. /// Order of the columns, from left to right: date, hour, minute, am/pm.
/// ///
/// Example: [Fri Aug 31 | 02 | 08 | PM]. /// Example: Fri Aug 31 | 02 | 08 | PM.
date_time_dayPeriod, date_time_dayPeriod,
/// Order of the columns, from left to right: date, am/pm, hour, minute. /// Order of the columns, from left to right: date, am/pm, hour, minute.
/// ///
/// Example: [Fri Aug 31 | PM | 02 | 08]. /// Example: Fri Aug 31 | PM | 02 | 08.
date_dayPeriod_time, date_dayPeriod_time,
/// Order of the columns, from left to right: hour, minute, am/pm, date. /// Order of the columns, from left to right: hour, minute, am/pm, date.
/// ///
/// Example: [02 | 08 | PM | Fri Aug 31]. /// Example: 02 | 08 | PM | Fri Aug 31.
time_dayPeriod_date, time_dayPeriod_date,
/// Order of the columns, from left to right: am/pm, hour, minute, date. /// Order of the columns, from left to right: am/pm, hour, minute, date.
/// ///
/// Example: [PM | 02 | 08 | Fri Aug 31]. /// Example: PM | 02 | 08 | Fri Aug 31.
dayPeriod_time_date, dayPeriod_time_date,
} }
...@@ -32,19 +34,19 @@ enum DatePickerDateTimeOrder { ...@@ -32,19 +34,19 @@ enum DatePickerDateTimeOrder {
enum DatePickerDateOrder { enum DatePickerDateOrder {
/// Order of the columns, from left to right: day, month, year. /// Order of the columns, from left to right: day, month, year.
/// ///
/// Example: [12 | March | 1996] /// Example: 12 | March | 1996
dmy, dmy,
/// Order of the columns, from left to right: month, day, year. /// Order of the columns, from left to right: month, day, year.
/// ///
/// Example: [March | 12 | 1996] /// Example: March | 12 | 1996
mdy, mdy,
/// Order of the columns, from left to right: year, month, day. /// Order of the columns, from left to right: year, month, day.
/// ///
/// Example: [1996 | March | 12] /// Example: 1996 | March | 12
ymd, ymd,
/// Order of the columns, from left to right: year, day, month. /// Order of the columns, from left to right: year, day, month.
/// ///
/// Example: [1996 | 12 | March] /// Example: 1996 | 12 | March
ydm, ydm,
} }
...@@ -131,7 +133,7 @@ abstract class CupertinoLocalizations { ...@@ -131,7 +133,7 @@ abstract class CupertinoLocalizations {
/// The term used by the system to announce dialog alerts. /// The term used by the system to announce dialog alerts.
String get alertDialogLabel; String get alertDialogLabel;
/// Hour that is shown in [CupertinoCountdownTimerPicker] corresponding to /// Hour that is shown in [CupertinoTimerPicker] corresponding to
/// the given hour value. /// the given hour value.
/// ///
/// Examples: timerPickerHour(1) in: /// Examples: timerPickerHour(1) in:
...@@ -140,7 +142,7 @@ abstract class CupertinoLocalizations { ...@@ -140,7 +142,7 @@ abstract class CupertinoLocalizations {
/// - Arabic: ١ /// - Arabic: ١
String timerPickerHour(int hour); String timerPickerHour(int hour);
/// Minute that is shown in [CupertinoCountdownTimerPicker] corresponding to /// Minute that is shown in [CupertinoTimerPicker] corresponding to
/// the given minute value. /// the given minute value.
/// ///
/// Examples: timerPickerMinute(1) in: /// Examples: timerPickerMinute(1) in:
...@@ -149,7 +151,7 @@ abstract class CupertinoLocalizations { ...@@ -149,7 +151,7 @@ abstract class CupertinoLocalizations {
/// - Arabic: ١ /// - Arabic: ١
String timerPickerMinute(int minute); String timerPickerMinute(int minute);
/// Second that is shown in [CupertinoCountdownTimerPicker] corresponding to /// Second that is shown in [CupertinoTimerPicker] corresponding to
/// the given second value. /// the given second value.
/// ///
/// Examples: timerPickerSecond(1) in: /// Examples: timerPickerSecond(1) in:
...@@ -159,17 +161,17 @@ abstract class CupertinoLocalizations { ...@@ -159,17 +161,17 @@ abstract class CupertinoLocalizations {
String timerPickerSecond(int second); String timerPickerSecond(int second);
/// Label that appears next to the hour picker in /// Label that appears next to the hour picker in
/// [CupertinoCountdownTimerPicker] when selected hour value is `hour`. /// [CupertinoTimerPicker] when selected hour value is `hour`.
/// This function will deal with pluralization based on the `hour` parameter. /// This function will deal with pluralization based on the `hour` parameter.
String timerPickerHourLabel(int hour); String timerPickerHourLabel(int hour);
/// Label that appears next to the minute picker in /// Label that appears next to the minute picker in
/// [CupertinoCountdownTimerPicker] when selected minute value is `minute`. /// [CupertinoTimerPicker] when selected minute value is `minute`.
/// This function will deal with pluralization based on the `minute` parameter. /// This function will deal with pluralization based on the `minute` parameter.
String timerPickerMinuteLabel(int minute); String timerPickerMinuteLabel(int minute);
/// Label that appears next to the minute picker in /// Label that appears next to the minute picker in
/// [CupertinoCountdownTimerPicker] when selected minute value is `second`. /// [CupertinoTimerPicker] when selected minute value is `second`.
/// This function will deal with pluralization based on the `second` parameter. /// This function will deal with pluralization based on the `second` parameter.
String timerPickerSecondLabel(int second); String timerPickerSecondLabel(int second);
......
...@@ -89,10 +89,7 @@ import 'theme.dart'; ...@@ -89,10 +89,7 @@ import 'theme.dart';
class CupertinoTabScaffold extends StatefulWidget { class CupertinoTabScaffold extends StatefulWidget {
/// Creates a layout for applications with a tab bar at the bottom. /// Creates a layout for applications with a tab bar at the bottom.
/// ///
/// The [tabBar], [tabBuilder] and [currentTabIndex] arguments must not be null. /// The [tabBar] and [tabBuilder] arguments must not be null.
///
/// The [currentTabIndex] argument can be used to programmatically change the
/// currently selected tab.
const CupertinoTabScaffold({ const CupertinoTabScaffold({
Key key, Key key,
@required this.tabBar, @required this.tabBar,
......
...@@ -294,10 +294,6 @@ class CupertinoTextField extends StatefulWidget { ...@@ -294,10 +294,6 @@ class CupertinoTextField extends StatefulWidget {
/// Whitespace characters (e.g. newline, space, tab) are included in the /// Whitespace characters (e.g. newline, space, tab) are included in the
/// character count. /// character count.
/// ///
/// If [maxLengthEnforced] is set to false, then more than [maxLength]
/// characters may be entered, but the error counter and divider will
/// switch to the [decoration.errorStyle] when the limit is exceeded.
///
/// ## Limitations /// ## Limitations
/// ///
/// The CupertinoTextField does not currently count Unicode grapheme clusters /// The CupertinoTextField does not currently count Unicode grapheme clusters
......
...@@ -703,7 +703,7 @@ abstract class DiagnosticsNode { ...@@ -703,7 +703,7 @@ abstract class DiagnosticsNode {
/// than `minLevel`. /// than `minLevel`.
/// ///
/// If `minLevel` is [DiagnosticLevel.hidden] no diagnostics will be filtered. /// If `minLevel` is [DiagnosticLevel.hidden] no diagnostics will be filtered.
/// If `minLevel` is [DiagnosticsLevel.off] all diagnostics will be filtered. /// If `minLevel` is [DiagnosticLevel.off] all diagnostics will be filtered.
bool isFiltered(DiagnosticLevel minLevel) => level.index < minLevel.index; bool isFiltered(DiagnosticLevel minLevel) => level.index < minLevel.index;
/// Priority level of the diagnostic used to control which diagnostics should /// Priority level of the diagnostic used to control which diagnostics should
...@@ -854,8 +854,7 @@ abstract class DiagnosticsNode { ...@@ -854,8 +854,7 @@ abstract class DiagnosticsNode {
/// ///
/// See also: /// See also:
/// ///
/// * [toString], for a brief description of the [value] but not its children. /// * [toString], for a brief description of the [value] but not its
/// * [toStringShallow], for a detailed description of the [value] but not its
/// children. /// children.
String toStringDeep({ String toStringDeep({
String prefixLineOne = '', String prefixLineOne = '',
...@@ -1558,7 +1557,7 @@ class EnumProperty<T> extends DiagnosticsProperty<T> { ...@@ -1558,7 +1557,7 @@ class EnumProperty<T> extends DiagnosticsProperty<T> {
/// The [ifPresent] and [ifNull] strings describe the property [value] when it /// The [ifPresent] and [ifNull] strings describe the property [value] when it
/// is non-null and null respectively. If one of [ifPresent] or [ifNull] is /// is non-null and null respectively. If one of [ifPresent] or [ifNull] is
/// omitted, that is taken to mean that [level] should be /// omitted, that is taken to mean that [level] should be
/// [DiagnosticsLevel.hidden] when [value] is non-null or null respectively. /// [DiagnosticLevel.hidden] when [value] is non-null or null respectively.
/// ///
/// This kind of diagnostics property is typically used for values mostly opaque /// This kind of diagnostics property is typically used for values mostly opaque
/// values, like closures, where presenting the actual object is of dubious /// values, like closures, where presenting the actual object is of dubious
...@@ -1615,7 +1614,7 @@ class ObjectFlagProperty<T> extends DiagnosticsProperty<T> { ...@@ -1615,7 +1614,7 @@ class ObjectFlagProperty<T> extends DiagnosticsProperty<T> {
/// Description to use if the property [value] is not null. /// Description to use if the property [value] is not null.
/// ///
/// If the property [value] is not null and [ifPresent] is null, the /// If the property [value] is not null and [ifPresent] is null, the
/// [level] for the property is [DiagnosticsLevel.hidden] and the description /// [level] for the property is [DiagnosticLevel.hidden] and the description
/// from superclass is used. /// from superclass is used.
final String ifPresent; final String ifPresent;
...@@ -2102,17 +2101,17 @@ class DiagnosticPropertiesBuilder { ...@@ -2102,17 +2101,17 @@ class DiagnosticPropertiesBuilder {
/// * [DiagnosticableTree], which extends this class to also describe the /// * [DiagnosticableTree], which extends this class to also describe the
/// children of a tree structured object. /// children of a tree structured object.
/// * [Diagnosticable.debugFillProperties], which lists best practices /// * [Diagnosticable.debugFillProperties], which lists best practices
/// for specifying the properties of a [DiagnosticNode]. The most common use /// for specifying the properties of a [DiagnosticsNode]. The most common use
/// case is to override [debugFillProperties] defining custom properties for /// case is to override [debugFillProperties] defining custom properties for
/// a subclass of [TreeDiagnosticsMixin] using the existing /// a subclass of [DiagnosticableTreeMixin] using the existing
/// [DiagnosticsProperty] subclasses. /// [DiagnosticsProperty] subclasses.
/// * [DiagnosticableTree.debugDescribeChildren], which lists best practices /// * [DiagnosticableTree.debugDescribeChildren], which lists best practices
/// for describing the children of a [DiagnosticNode]. Typically the base /// for describing the children of a [DiagnosticsNode]. Typically the base
/// class already describes the children of a node properly or a node has /// class already describes the children of a node properly or a node has
/// no children. /// no children.
/// * [DiagnosticsProperty], which should be used to create leaf diagnostic /// * [DiagnosticsProperty], which should be used to create leaf diagnostic
/// nodes without properties or children. There are many [DiagnosticProperty] /// nodes without properties or children. There are many
/// subclasses to handle common use cases. /// [DiagnosticsProperty] subclasses to handle common use cases.
abstract class Diagnosticable { abstract class Diagnosticable {
/// Abstract const constructor. This constructor enables subclasses to provide /// Abstract const constructor. This constructor enables subclasses to provide
/// const constructors so that they can be used in const expressions. /// const constructors so that they can be used in const expressions.
...@@ -2132,7 +2131,7 @@ abstract class Diagnosticable { ...@@ -2132,7 +2131,7 @@ abstract class Diagnosticable {
} }
/// Returns a debug representation of the object that is used by debugging /// Returns a debug representation of the object that is used by debugging
/// tools and by [toStringDeep]. /// tools and by [DiagnosticsNode.toStringDeep].
/// ///
/// Leave [name] as null if there is not a meaningful description of the /// Leave [name] as null if there is not a meaningful description of the
/// relationship between the this node and its parent. /// relationship between the this node and its parent.
......
...@@ -7,6 +7,7 @@ import 'dart:async'; ...@@ -7,6 +7,7 @@ import 'dart:async';
import 'package:flutter/foundation.dart'; import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart'; import 'package:flutter/widgets.dart';
import 'reorderable_list.dart';
import 'text_theme.dart'; import 'text_theme.dart';
import 'time.dart'; import 'time.dart';
import 'typography.dart'; import 'typography.dart';
...@@ -277,27 +278,27 @@ abstract class MaterialLocalizations { ...@@ -277,27 +278,27 @@ abstract class MaterialLocalizations {
/// shows the list of accounts. /// shows the list of accounts.
String get showAccountsLabel; String get showAccountsLabel;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list to the start of the list. /// list to the start of the list.
String get reorderItemToStart; String get reorderItemToStart;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list to the end of the list. /// list to the end of the list.
String get reorderItemToEnd; String get reorderItemToEnd;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list one space up the list. /// list one space up the list.
String get reorderItemUp; String get reorderItemUp;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list one space down the list. /// list one space down the list.
String get reorderItemDown; String get reorderItemDown;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list one space left in the list. /// list one space left in the list.
String get reorderItemLeft; String get reorderItemLeft;
/// The semantics label used for [ReorderableList] to reorder an item in the /// The semantics label used for [ReorderableListView] to reorder an item in the
/// list one space right in the list. /// list one space right in the list.
String get reorderItemRight; String get reorderItemRight;
......
...@@ -2621,8 +2621,8 @@ class SemanticsConfiguration { ...@@ -2621,8 +2621,8 @@ class SemanticsConfiguration {
/// is set on the same node, all previously painted siblings and cousins up /// is set on the same node, all previously painted siblings and cousins up
/// until the next ancestor that is a semantic boundary are dropped. /// until the next ancestor that is a semantic boundary are dropped.
/// ///
/// Paint order as established by [visitChildrenForSemantics] is used to /// Paint order as established by [RenderObject.visitChildrenForSemantics] is
/// determine if a node is previous to this one. /// used to determine if a node is previous to this one.
bool isBlockingSemanticsOfPreviouslyPaintedNodes = false; bool isBlockingSemanticsOfPreviouslyPaintedNodes = false;
// SEMANTIC ANNOTATIONS // SEMANTIC ANNOTATIONS
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment