Skip to content

Commit

Permalink
fix some unintended HTML tags in docs (flutter#153507)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
goderbauer authored and Buchimi committed Sep 2, 2024
1 parent 58dddbf commit 6cc4550
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ linter:
- type_init_formals
- type_literal_in_constant_pattern
# - unawaited_futures # too many false positives, especially with the way AnimationController works
# - unintended_html_in_doc_comment # not yet tested
# - unintended_html_in_doc_comment # blocked on https://github.com/dart-lang/linter/issues/5065
- unnecessary_await_in_return
- unnecessary_brace_in_string_interps
- unnecessary_breaks
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter/lib/src/painting/image_resolution.dart
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ class AssetImage extends AssetBundleImageProvider {

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

/// The bundle from which the image will be obtained.
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter/lib/src/painting/linear_border.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import 'basic_types.dart';
import 'borders.dart';
import 'edge_insets.dart';

/// Defines the relative size and alignment of one <LinearBorder> edge.
/// Defines the relative size and alignment of one [LinearBorder] edge.
///
/// A [LinearBorder] defines a box outline as zero to four edges, each
/// of which is rendered as a single line. The width and color of the
Expand Down
4 changes: 2 additions & 2 deletions packages/flutter/lib/src/semantics/semantics.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1642,7 +1642,7 @@ class SemanticsProperties extends DiagnosticableTree {
/// This handler is invoked when the user wants to replace the current text in
/// the text field with a new text.
///
/// Voice access users can trigger this handler by speaking "type <text>" to
/// Voice access users can trigger this handler by speaking `type <text>` to
/// their Android devices.
final SetTextHandler? onSetText;

Expand Down Expand Up @@ -4111,7 +4111,7 @@ class SemanticsConfiguration {
/// This handler is invoked when the user wants to replace the current text in
/// the text field with a new text.
///
/// Voice access users can trigger this handler by speaking "type <text>" to
/// Voice access users can trigger this handler by speaking `type <text>` to
/// their Android devices.
SetTextHandler? get onSetText => _onSetText;
SetTextHandler? _onSetText;
Expand Down
4 changes: 2 additions & 2 deletions packages/flutter/lib/src/widgets/dismissible.dart
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,10 @@ class Dismissible extends StatefulWidget {
///
/// The widget cannot be dragged again until the returned future resolves.
///
/// If the returned Future<bool> completes true, then this widget will be
/// If the returned `Future<bool>` completes true, then this widget will be
/// dismissed, otherwise it will be moved back to its original location.
///
/// If the returned Future<bool?> completes to false or null the [onResize]
/// If the returned `Future<bool?>` completes to false or null the [onResize]
/// and [onDismissed] callbacks will not run.
final ConfirmDismissCallback? confirmDismiss;

Expand Down
4 changes: 2 additions & 2 deletions packages/flutter/lib/src/widgets/scrollable_helpers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ class ScrollableDetails {
///
/// The scroll velocity is controlled by the [velocityScalar]:
///
/// velocity = <distance of overscroll> * [velocityScalar].
/// velocity = (distance of overscroll) * [velocityScalar].
class EdgeDraggingAutoScroller {
/// Creates a auto scroller that scrolls the [scrollable].
EdgeDraggingAutoScroller(
Expand All @@ -179,7 +179,7 @@ class EdgeDraggingAutoScroller {
/// The velocity scalar per pixel over scroll.
///
/// It represents how the velocity scale with the over scroll distance. The
/// auto-scroll velocity = <distance of overscroll> * velocityScalar.
/// auto-scroll velocity = (distance of overscroll) * velocityScalar.
/// {@endtemplate}
final double velocityScalar;

Expand Down

0 comments on commit 6cc4550

Please sign in to comment.