Skip to content

Commit d9dbefc

Browse files
authored
fix some unintended HTML tags in docs (#153507)
I used the `unintended_html_in_doc_comment` to find these, but sadly the lint is not ready to be enabled yet due to https://github.com/dart-lang/linter/issues/5065.
1 parent 887afe2 commit d9dbefc

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

analysis_options.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ linter:
208208
- type_init_formals
209209
- type_literal_in_constant_pattern
210210
# - unawaited_futures # too many false positives, especially with the way AnimationController works
211-
# - unintended_html_in_doc_comment # not yet tested
211+
# - unintended_html_in_doc_comment # blocked on https://github.com/dart-lang/linter/issues/5065
212212
- unnecessary_await_in_return
213213
- unnecessary_brace_in_string_interps
214214
- unnecessary_breaks

packages/flutter/lib/src/painting/image_resolution.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ class AssetImage extends AssetBundleImageProvider {
252252

253253
/// The name used to generate the key to obtain the asset. For local assets
254254
/// this is [assetName], and for assets from packages the [assetName] is
255-
/// prefixed 'packages/<package_name>/'.
255+
/// prefixed `packages/<package_name>/`.
256256
String get keyName => package == null ? assetName : 'packages/$package/$assetName';
257257

258258
/// The bundle from which the image will be obtained.

packages/flutter/lib/src/painting/linear_border.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import 'basic_types.dart';
1313
import 'borders.dart';
1414
import 'edge_insets.dart';
1515

16-
/// Defines the relative size and alignment of one <LinearBorder> edge.
16+
/// Defines the relative size and alignment of one [LinearBorder] edge.
1717
///
1818
/// A [LinearBorder] defines a box outline as zero to four edges, each
1919
/// of which is rendered as a single line. The width and color of the

packages/flutter/lib/src/semantics/semantics.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -1642,7 +1642,7 @@ class SemanticsProperties extends DiagnosticableTree {
16421642
/// This handler is invoked when the user wants to replace the current text in
16431643
/// the text field with a new text.
16441644
///
1645-
/// Voice access users can trigger this handler by speaking "type <text>" to
1645+
/// Voice access users can trigger this handler by speaking `type <text>` to
16461646
/// their Android devices.
16471647
final SetTextHandler? onSetText;
16481648

@@ -4111,7 +4111,7 @@ class SemanticsConfiguration {
41114111
/// This handler is invoked when the user wants to replace the current text in
41124112
/// the text field with a new text.
41134113
///
4114-
/// Voice access users can trigger this handler by speaking "type <text>" to
4114+
/// Voice access users can trigger this handler by speaking `type <text>` to
41154115
/// their Android devices.
41164116
SetTextHandler? get onSetText => _onSetText;
41174117
SetTextHandler? _onSetText;

packages/flutter/lib/src/widgets/dismissible.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,10 @@ class Dismissible extends StatefulWidget {
136136
///
137137
/// The widget cannot be dragged again until the returned future resolves.
138138
///
139-
/// If the returned Future<bool> completes true, then this widget will be
139+
/// If the returned `Future<bool>` completes true, then this widget will be
140140
/// dismissed, otherwise it will be moved back to its original location.
141141
///
142-
/// If the returned Future<bool?> completes to false or null the [onResize]
142+
/// If the returned `Future<bool?>` completes to false or null the [onResize]
143143
/// and [onDismissed] callbacks will not run.
144144
final ConfirmDismissCallback? confirmDismiss;
145145

packages/flutter/lib/src/widgets/scrollable_helpers.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ class ScrollableDetails {
156156
///
157157
/// The scroll velocity is controlled by the [velocityScalar]:
158158
///
159-
/// velocity = <distance of overscroll> * [velocityScalar].
159+
/// velocity = (distance of overscroll) * [velocityScalar].
160160
class EdgeDraggingAutoScroller {
161161
/// Creates a auto scroller that scrolls the [scrollable].
162162
EdgeDraggingAutoScroller(
@@ -179,7 +179,7 @@ class EdgeDraggingAutoScroller {
179179
/// The velocity scalar per pixel over scroll.
180180
///
181181
/// It represents how the velocity scale with the over scroll distance. The
182-
/// auto-scroll velocity = <distance of overscroll> * velocityScalar.
182+
/// auto-scroll velocity = (distance of overscroll) * velocityScalar.
183183
/// {@endtemplate}
184184
final double velocityScalar;
185185

0 commit comments

Comments
 (0)