Skip to content

Commit 88809aa

Browse files
authored
Standardize dartdoc macro names (flutter#69445)
1 parent 03a3457 commit 88809aa

File tree

140 files changed

+659
-661
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+659
-661
lines changed

dev/integration_tests/hybrid_android_views/lib/android_platform_view.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@ class AndroidPlatformView extends StatelessWidget {
2626
/// A PlatformViewFactory for this type must have been registered.
2727
final String viewType;
2828

29-
/// {@template flutter.widgets.platformViews.createdParam}
3029
/// Callback to invoke after the platform view has been created.
3130
///
3231
/// May be null.
33-
/// {@endtemplate}
3432
final PlatformViewCreatedCallback onPlatformViewCreated;
3533

3634
@override

packages/flutter/lib/src/animation/curves.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ class Curve2DSample {
578578
/// smoothly from one control point to the next, passing through the control
579579
/// points.
580580
///
581-
/// {@template flutter.animation.curves.catmull_rom_description}
581+
/// {@template flutter.animation.CatmullRomSpline}
582582
/// Unlike most cubic splines, Catmull-Rom splines have the advantage that their
583583
/// curves pass through the control points given to them. They are cubic
584584
/// polynomial representations, and, in fact, Catmull-Rom splines can be
@@ -766,7 +766,7 @@ class CatmullRomSpline extends Curve2D {
766766
/// smoothly from one control point to the next, passing through (0.0, 0.0), the
767767
/// given points, and then (1.0, 1.0).
768768
///
769-
/// {@macro flutter.animation.curves.catmull_rom_description}
769+
/// {@macro flutter.animation.CatmullRomSpline}
770770
///
771771
/// This class uses a centripetal Catmull-Rom curve (a [CatmullRomSpline]) as
772772
/// its internal representation. The term centripetal implies that it won't form

packages/flutter/lib/src/cupertino/app.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ class CupertinoApp extends StatefulWidget {
226226
/// This callback is passed along to the [WidgetsApp] built by this widget.
227227
final LocaleListResolutionCallback? localeListResolutionCallback;
228228

229-
/// {@macro flutter.widgets.widgetsApp.localeResolutionCallback}
229+
/// {@macro flutter.widgets.LocaleResolutionCallback}
230230
///
231231
/// This callback is passed along to the [WidgetsApp] built by this widget.
232232
final LocaleResolutionCallback? localeResolutionCallback;

packages/flutter/lib/src/cupertino/nav_bar.dart

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
235235
),
236236
super(key: key);
237237

238-
/// {@template flutter.cupertino.navBar.leading}
238+
/// {@template flutter.cupertino.CupertinoNavigationBar.leading}
239239
/// Widget to place at the start of the navigation bar. Normally a back button
240240
/// for a normal page or a cancel button for full page dialogs.
241241
///
@@ -244,7 +244,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
244244
/// {@endtemplate}
245245
final Widget? leading;
246246

247-
/// {@template flutter.cupertino.navBar.automaticallyImplyLeading}
247+
/// {@template flutter.cupertino.CupertinoNavigationBar.automaticallyImplyLeading}
248248
/// Controls whether we should try to imply the leading widget if null.
249249
///
250250
/// If true and [leading] is null, automatically try to deduce what the [leading]
@@ -272,7 +272,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
272272
/// This value cannot be null.
273273
final bool automaticallyImplyMiddle;
274274

275-
/// {@template flutter.cupertino.navBar.previousPageTitle}
275+
/// {@template flutter.cupertino.CupertinoNavigationBar.previousPageTitle}
276276
/// Manually specify the previous route's title when automatically implying
277277
/// the leading back button.
278278
///
@@ -293,7 +293,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
293293
/// has a `title`.
294294
final Widget? middle;
295295

296-
/// {@template flutter.cupertino.navBar.trailing}
296+
/// {@template flutter.cupertino.CupertinoNavigationBar.trailing}
297297
/// Widget to place at the end of the navigation bar. Normally additional actions
298298
/// taken on the page such as a search or edit function.
299299
/// {@endtemplate}
@@ -302,7 +302,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
302302
// TODO(xster): https://github.com/flutter/flutter/issues/10469 implement
303303
// support for double row navigation bars.
304304

305-
/// {@template flutter.cupertino.navBar.backgroundColor}
305+
/// {@template flutter.cupertino.CupertinoNavigationBar.backgroundColor}
306306
/// The background color of the navigation bar. If it contains transparency, the
307307
/// tab bar will automatically produce a blurring effect to the content
308308
/// behind it.
@@ -311,7 +311,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
311311
/// {@endtemplate}
312312
final Color? backgroundColor;
313313

314-
/// {@template flutter.cupertino.navBar.brightness}
314+
/// {@template flutter.cupertino.CupertinoNavigationBar.brightness}
315315
/// The brightness of the specified [backgroundColor].
316316
///
317317
/// Setting this value changes the style of the system status bar. Typically
@@ -323,7 +323,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
323323
/// {@endtemplate}
324324
final Brightness? brightness;
325325

326-
/// {@template flutter.cupertino.navBar.padding}
326+
/// {@template flutter.cupertino.CupertinoNavigationBar.padding}
327327
/// Padding for the contents of the navigation bar.
328328
///
329329
/// If null, the navigation bar will adopt the following defaults:
@@ -338,14 +338,14 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
338338
/// {@endtemplate}
339339
final EdgeInsetsDirectional? padding;
340340

341-
/// {@template flutter.cupertino.navBar.border}
341+
/// {@template flutter.cupertino.CupertinoNavigationBar.border}
342342
/// The border of the navigation bar. By default renders a single pixel bottom border side.
343343
///
344344
/// If a border is null, the navigation bar will not display a border.
345345
/// {@endtemplate}
346346
final Border? border;
347347

348-
/// {@template flutter.cupertino.navBar.actionsForegroundColor}
348+
/// {@template flutter.cupertino.CupertinoNavigationBar.actionsForegroundColor}
349349
/// Default color used for text and icons of the [leading] and [trailing]
350350
/// widgets in the navigation bar.
351351
///
@@ -360,7 +360,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
360360
)
361361
final Color? actionsForegroundColor;
362362

363-
/// {@template flutter.cupertino.navBar.transitionBetweenRoutes}
363+
/// {@template flutter.cupertino.CupertinoNavigationBar.transitionBetweenRoutes}
364364
/// Whether to transition between navigation bars.
365365
///
366366
/// When [transitionBetweenRoutes] is true, this navigation bar will transition
@@ -379,7 +379,7 @@ class CupertinoNavigationBar extends StatefulWidget implements ObstructingPrefer
379379
/// {@endtemplate}
380380
final bool transitionBetweenRoutes;
381381

382-
/// {@template flutter.cupertino.navBar.heroTag}
382+
/// {@template flutter.cupertino.CupertinoNavigationBar.heroTag}
383383
/// Tag for the navigation bar's Hero widget if [transitionBetweenRoutes] is true.
384384
///
385385
/// Defaults to a common tag between all [CupertinoNavigationBar] and
@@ -608,12 +608,12 @@ class CupertinoSliverNavigationBar extends StatefulWidget {
608608
/// ([CupertinoPageRoute.title]) and [automaticallyImplyTitle] must be true.
609609
final Widget? largeTitle;
610610

611-
/// {@macro flutter.cupertino.navBar.leading}
611+
/// {@macro flutter.cupertino.CupertinoNavigationBar.leading}
612612
///
613613
/// This widget is visible in both collapsed and expanded states.
614614
final Widget? leading;
615615

616-
/// {@macro flutter.cupertino.navBar.automaticallyImplyLeading}
616+
/// {@macro flutter.cupertino.CupertinoNavigationBar.automaticallyImplyLeading}
617617
final bool automaticallyImplyLeading;
618618

619619
/// Controls whether we should try to imply the [largeTitle] widget if null.
@@ -625,7 +625,7 @@ class CupertinoSliverNavigationBar extends StatefulWidget {
625625
/// This value cannot be null.
626626
final bool automaticallyImplyTitle;
627627

628-
/// {@macro flutter.cupertino.navBar.previousPageTitle}
628+
/// {@macro flutter.cupertino.CupertinoNavigationBar.previousPageTitle}
629629
final String? previousPageTitle;
630630

631631
/// A widget to place in the middle of the static navigation bar instead of
@@ -636,24 +636,24 @@ class CupertinoSliverNavigationBar extends StatefulWidget {
636636
/// [middle] widget is provided.
637637
final Widget? middle;
638638

639-
/// {@macro flutter.cupertino.navBar.trailing}
639+
/// {@macro flutter.cupertino.CupertinoNavigationBar.trailing}
640640
///
641641
/// This widget is visible in both collapsed and expanded states.
642642
final Widget? trailing;
643643

644-
/// {@macro flutter.cupertino.navBar.backgroundColor}
644+
/// {@macro flutter.cupertino.CupertinoNavigationBar.backgroundColor}
645645
final Color? backgroundColor;
646646

647-
/// {@macro flutter.cupertino.navBar.brightness}
647+
/// {@macro flutter.cupertino.CupertinoNavigationBar.brightness}
648648
final Brightness? brightness;
649649

650-
/// {@macro flutter.cupertino.navBar.padding}
650+
/// {@macro flutter.cupertino.CupertinoNavigationBar.padding}
651651
final EdgeInsetsDirectional? padding;
652652

653-
/// {@macro flutter.cupertino.navBar.border}
653+
/// {@macro flutter.cupertino.CupertinoNavigationBar.border}
654654
final Border? border;
655655

656-
/// {@macro flutter.cupertino.navBar.actionsForegroundColor}
656+
/// {@macro flutter.cupertino.CupertinoNavigationBar.actionsForegroundColor}
657657
///
658658
/// The default color for text in the [largeTitle] slot is always black, as per
659659
/// iOS standard design.
@@ -663,10 +663,10 @@ class CupertinoSliverNavigationBar extends StatefulWidget {
663663
)
664664
final Color? actionsForegroundColor;
665665

666-
/// {@macro flutter.cupertino.navBar.transitionBetweenRoutes}
666+
/// {@macro flutter.cupertino.CupertinoNavigationBar.transitionBetweenRoutes}
667667
final bool transitionBetweenRoutes;
668668

669-
/// {@macro flutter.cupertino.navBar.heroTag}
669+
/// {@macro flutter.cupertino.CupertinoNavigationBar.heroTag}
670670
final Object heroTag;
671671

672672
/// True if the navigation bar's background color has no transparency.

packages/flutter/lib/src/cupertino/picker.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class CupertinoPicker extends StatefulWidget {
9999
///
100100
/// The [itemBuilder] argument must not be null. The [childCount] argument
101101
/// reflects the number of children that will be provided by the [itemBuilder].
102-
/// {@macro flutter.widgets.wheelList.childCount}
102+
/// {@macro flutter.widgets.ListWheelChildBuilderDelegate.childCount}
103103
///
104104
/// The [itemExtent] argument must be non-null and positive.
105105
///
@@ -150,13 +150,13 @@ class CupertinoPicker extends StatefulWidget {
150150
/// wheel list edge fade gradient from rendering of the widget.
151151
final Color? backgroundColor;
152152

153-
/// {@macro flutter.rendering.wheelList.offAxisFraction}
153+
/// {@macro flutter.rendering.RenderListWheelViewport.offAxisFraction}
154154
final double offAxisFraction;
155155

156-
/// {@macro flutter.rendering.wheelList.useMagnifier}
156+
/// {@macro flutter.rendering.RenderListWheelViewport.useMagnifier}
157157
final bool useMagnifier;
158158

159-
/// {@macro flutter.rendering.wheelList.magnification}
159+
/// {@macro flutter.rendering.RenderListWheelViewport.magnification}
160160
final double magnification;
161161

162162
/// A [FixedExtentScrollController] to read and control the current item, and
@@ -171,7 +171,7 @@ class CupertinoPicker extends StatefulWidget {
171171
/// height. Must not be null and must be positive.
172172
final double itemExtent;
173173

174-
/// {@macro flutter.rendering.wheelList.squeeze}
174+
/// {@macro flutter.rendering.RenderListWheelViewport.squeeze}
175175
///
176176
/// Defaults to `1.45` to visually mimic iOS.
177177
final double squeeze;

packages/flutter/lib/src/cupertino/route.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ mixin CupertinoRouteTransitionMixin<T> on PageRoute<T> {
9696
@protected
9797
Widget buildContent(BuildContext context);
9898

99-
/// {@template flutter.cupertino.cupertinoRouteTransitionMixin.title}
99+
/// {@template flutter.cupertino.CupertinoRouteTransitionMixin.title}
100100
/// A title string for this route.
101101
///
102102
/// Used to auto-populate [CupertinoNavigationBar] and
@@ -433,13 +433,13 @@ class CupertinoPage<T> extends Page<T> {
433433
/// The content to be shown in the [Route] created by this page.
434434
final Widget child;
435435

436-
/// {@macro flutter.cupertino.cupertinoRouteTransitionMixin.title}
436+
/// {@macro flutter.cupertino.CupertinoRouteTransitionMixin.title}
437437
final String? title;
438438

439-
/// {@macro flutter.widgets.modalRoute.maintainState}
439+
/// {@macro flutter.widgets.ModalRoute.maintainState}
440440
final bool maintainState;
441441

442-
/// {@macro flutter.widgets.pageRoute.fullscreenDialog}
442+
/// {@macro flutter.widgets.PageRoute.fullscreenDialog}
443443
final bool fullscreenDialog;
444444

445445
@override

packages/flutter/lib/src/cupertino/switch.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ class CupertinoSwitch extends StatefulWidget {
106106
/// Defaults to [CupertinoColors.secondarySystemFill] when null.
107107
final Color? trackColor;
108108

109-
/// {@template flutter.cupertino.switch.dragStartBehavior}
109+
/// {@template flutter.cupertino.CupertinoSwitch.dragStartBehavior}
110110
/// Determines the way that drag start behavior is handled.
111111
///
112112
/// If set to [DragStartBehavior.start], the drag behavior used to move the

packages/flutter/lib/src/cupertino/text_field.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class _CupertinoTextFieldSelectionGestureDetectorBuilder extends TextSelectionGe
131131
/// field (e.g., by pressing a button on the soft keyboard), the text field
132132
/// calls the [onSubmitted] callback.
133133
///
134-
/// {@macro flutter.widgets.editableText.complexCharacters}
134+
/// {@macro flutter.widgets.EditableText.onChanged}
135135
///
136136
/// To control the text that is displayed in the text field, use the
137137
/// [controller]. For example, to set the initial value of the text field, use
@@ -430,7 +430,7 @@ class CupertinoTextField extends StatefulWidget {
430430
/// paste and cut will be disabled regardless.
431431
final ToolbarOptions toolbarOptions;
432432

433-
/// {@macro flutter.widgets.inputDecorator.textAlignVertical}
433+
/// {@macro flutter.material.InputDecorator.textAlignVertical}
434434
final TextAlignVertical? textAlignVertical;
435435

436436
/// {@macro flutter.widgets.editableText.readOnly}
@@ -451,13 +451,13 @@ class CupertinoTextField extends StatefulWidget {
451451
/// {@macro flutter.widgets.editableText.autocorrect}
452452
final bool autocorrect;
453453

454-
/// {@macro flutter.services.textInput.smartDashesType}
454+
/// {@macro flutter.services.TextInputConfiguration.smartDashesType}
455455
final SmartDashesType smartDashesType;
456456

457-
/// {@macro flutter.services.textInput.smartQuotesType}
457+
/// {@macro flutter.services.TextInputConfiguration.smartQuotesType}
458458
final SmartQuotesType smartQuotesType;
459459

460-
/// {@macro flutter.services.textInput.enableSuggestions}
460+
/// {@macro flutter.services.TextInputConfiguration.enableSuggestions}
461461
final bool enableSuggestions;
462462

463463
/// {@macro flutter.widgets.editableText.maxLines}
@@ -579,7 +579,7 @@ class CupertinoTextField extends StatefulWidget {
579579
final GestureTapCallback? onTap;
580580

581581
/// {@macro flutter.widgets.editableText.autofillHints}
582-
/// {@macro flutter.services.autofill.autofillHints}
582+
/// {@macro flutter.services.AutofillConfiguration.autofillHints}
583583
final Iterable<String>? autofillHints;
584584

585585
/// {@macro flutter.material.textfield.restorationId}

packages/flutter/lib/src/cupertino/theme.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ class CupertinoTheme extends StatelessWidget {
113113

114114
/// The widget below this widget in the tree.
115115
///
116-
/// {@macro flutter.widgets.child}
116+
/// {@macro flutter.widgets.ProxyWidget.child}
117117
final Widget child;
118118

119119
@override

packages/flutter/lib/src/foundation/binding.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ abstract class BindingBase {
117117
/// Implementations of this method must call their superclass
118118
/// implementation.
119119
///
120-
/// {@macro flutter.foundation.bindingBase.registerServiceExtension}
120+
/// {@macro flutter.foundation.BindingBase.registerServiceExtension}
121121
///
122122
/// See also:
123123
///
@@ -310,7 +310,7 @@ abstract class BindingBase {
310310
///
311311
/// Calls the `callback` callback when the service extension is called.
312312
///
313-
/// {@macro flutter.foundation.bindingBase.registerServiceExtension}
313+
/// {@macro flutter.foundation.BindingBase.registerServiceExtension}
314314
@protected
315315
void registerSignalServiceExtension({
316316
required String name,
@@ -340,7 +340,7 @@ abstract class BindingBase {
340340
/// Calls the `setter` callback with the new value when the
341341
/// service extension method is called with a new value.
342342
///
343-
/// {@macro flutter.foundation.bindingBase.registerServiceExtension}
343+
/// {@macro flutter.foundation.BindingBase.registerServiceExtension}
344344
@protected
345345
void registerBoolServiceExtension({
346346
required String name,
@@ -374,7 +374,7 @@ abstract class BindingBase {
374374
/// Calls the `setter` callback with the new value when the
375375
/// service extension method is called with a new value.
376376
///
377-
/// {@macro flutter.foundation.bindingBase.registerServiceExtension}
377+
/// {@macro flutter.foundation.BindingBase.registerServiceExtension}
378378
@protected
379379
void registerNumericServiceExtension({
380380
required String name,
@@ -436,7 +436,7 @@ abstract class BindingBase {
436436
/// Calls the `setter` callback with the new value when the
437437
/// service extension method is called with a new value.
438438
///
439-
/// {@macro flutter.foundation.bindingBase.registerServiceExtension}
439+
/// {@macro flutter.foundation.BindingBase.registerServiceExtension}
440440
@protected
441441
void registerStringServiceExtension({
442442
required String name,
@@ -470,7 +470,7 @@ abstract class BindingBase {
470470
///
471471
/// The returned map will be mutated.
472472
///
473-
/// {@template flutter.foundation.bindingBase.registerServiceExtension}
473+
/// {@template flutter.foundation.BindingBase.registerServiceExtension}
474474
/// A registered service extension can only be activated if the vm-service
475475
/// is included in the build, which only happens in debug and profile mode.
476476
/// Although a service extension cannot be used in release mode its code may

0 commit comments

Comments
 (0)