[multi] Remove @tool from docs that does not work (#9394)

Piinks · web-flow · commit c05fd0b4c7e6 · 2025-06-06T16:28:50.000Z
![Screenshot 2025-06-05 at 6 10 11 PM](https://github.com/user-attachments/assets/7f6515c4-bc23-4574-b5b2-e3e411bb44e6) Usage of `@tool sample` and `@tool snippet` are not rendered in package docs here like they are in flutter/flutter. ## Pre-Review Checklist [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
diff --git a/packages/go_router/CHANGELOG.md b/packages/go_router/CHANGELOG.md
@@ -1,6 +1,7 @@
-## NEXT
+## 15.1.3
 
 * Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.
+* Fixes typo in API docs.
 
 ## 15.1.2
 
diff --git a/packages/go_router/lib/src/route.dart b/packages/go_router/lib/src/route.dart
@@ -301,7 +301,6 @@ class GoRoute extends RouteBase {
   /// property can be used to navigate to this route without knowing exact the
   /// URI of it.
   ///
-  /// {@tool snippet}
   /// Typical usage is as follows:
   ///
   /// ```dart
@@ -326,7 +325,6 @@ class GoRoute extends RouteBase {
   ///   queryParameters: <String, String>{'qid': 'quid'},
   /// );
   /// ```
-  /// {@end-tool}
   ///
   /// See the [named routes example](https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/named_routes.dart)
   /// for a complete runnable app.
diff --git a/packages/go_router/pubspec.yaml b/packages/go_router/pubspec.yaml
@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 15.1.2
+version: 15.1.3
 repository: https://github.com/flutter/packages/tree/main/packages/go_router
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22
 
diff --git a/packages/two_dimensional_scrollables/CHANGELOG.md b/packages/two_dimensional_scrollables/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.3.6
+
+* Fixes typo in API docs.
+
 ## 0.3.5
 
 * Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.
diff --git a/packages/two_dimensional_scrollables/lib/src/common/span.dart b/packages/two_dimensional_scrollables/lib/src/common/span.dart
@@ -346,7 +346,6 @@ class SpanDecoration {
   /// This same row decoration will consume any padding from the column spans so
   /// as to decorate the row as one continuous span.
   ///
-  /// {@tool snippet}
   /// This example illustrates how [consumeSpanPadding] affects
   /// [SpanDecoration.color]. By default, the color of the decoration
   /// consumes the padding, coloring the row fully by including the padding
@@ -379,7 +378,6 @@ class SpanDecoration {
   ///   },
   /// );
   /// ```
-  /// {@end-tool}
   final bool consumeSpanPadding;
 
   /// Called to draw the decoration around a span.
diff --git a/packages/two_dimensional_scrollables/pubspec.yaml b/packages/two_dimensional_scrollables/pubspec.yaml
@@ -1,6 +1,6 @@
 name: two_dimensional_scrollables
 description: Widgets that scroll using the two dimensional scrolling foundation.
-version: 0.3.5
+version: 0.3.6
 repository: https://github.com/flutter/packages/tree/main/packages/two_dimensional_scrollables
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+two_dimensional_scrollables%22+
 
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md b/packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md
@@ -1,6 +1,7 @@
-## NEXT
+## 2.13.1
 
 * Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.
+* Fixes typo in API docs.
 
 ## 2.13.0
 
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/javascript_message.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/javascript_message.dart
@@ -10,7 +10,6 @@ import 'package:flutter/foundation.dart';
 /// this class and providing a factory method that takes the
 /// [JavaScriptMessage] as a parameter.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [JavaScriptMessage] to
 /// provide additional platform specific parameters.
 ///
@@ -38,7 +37,6 @@ import 'package:flutter/foundation.dart';
 ///   final String? extraData;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class JavaScriptMessage {
   /// Creates a new JavaScript message object.
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/load_request_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/load_request_params.dart
@@ -33,7 +33,6 @@ extension LoadRequestMethodExtensions on LoadRequestMethod {
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [LoadRequestParams] to
 /// provide additional platform specific parameters.
 ///
@@ -62,7 +61,6 @@ extension LoadRequestMethodExtensions on LoadRequestMethod {
 ///   final Uri? historyUrl;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class LoadRequestParams {
   /// Used by the platform implementation to create a new [LoadRequestParams].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_navigation_delegate_creation_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_navigation_delegate_creation_params.dart
@@ -9,7 +9,6 @@ import 'package:flutter/material.dart';
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [PlatformNavigationDelegateCreationParams] to
 /// provide additional platform specific parameters.
 ///
@@ -36,7 +35,6 @@ import 'package:flutter/material.dart';
 ///   final String? filter;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class PlatformNavigationDelegateCreationParams {
   /// Used by the platform implementation to create a new [PlatformNavigationkDelegate].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_controller_creation_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_controller_creation_params.dart
@@ -9,7 +9,6 @@ import 'package:flutter/material.dart';
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [PlatformWebViewControllerCreationParams] to
 /// provide additional platform specific parameters.
 ///
@@ -37,7 +36,6 @@ import 'package:flutter/material.dart';
 ///   final String? domain;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class PlatformWebViewControllerCreationParams {
   /// Used by the platform implementation to create a new [PlatformWebViewController].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_cookie_manager_creation_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_cookie_manager_creation_params.dart
@@ -9,7 +9,6 @@ import 'package:flutter/material.dart';
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [PlatformWebViewCookieManagerCreationParams] to
 /// provide additional platform specific parameters.
 ///
@@ -37,7 +36,6 @@ import 'package:flutter/material.dart';
 ///   final Uri? uri;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class PlatformWebViewCookieManagerCreationParams {
   /// Used by the platform implementation to create a new [PlatformWebViewCookieManagerDelegate].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_widget_creation_params.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/platform_webview_widget_creation_params.dart
@@ -13,7 +13,6 @@ import '../platform_webview_controller.dart';
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [PlatformWebViewWidgetCreationParams] to
 /// provide additional platform specific parameters.
 ///
@@ -44,7 +43,6 @@ import '../platform_webview_controller.dart';
 ///   final Object? platformSpecificFieldExample;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class PlatformWebViewWidgetCreationParams {
   /// Used by the platform implementation to create a new [PlatformWebViewWidget].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/web_resource_error.dart b/packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/web_resource_error.dart
@@ -72,7 +72,6 @@ enum WebResourceErrorType {
 /// Platform specific implementations can add additional fields by extending
 /// this class.
 ///
-/// {@tool sample}
 /// This example demonstrates how to extend the [WebResourceError] to
 /// provide additional platform specific parameters.
 ///
@@ -98,7 +97,6 @@ enum WebResourceErrorType {
 ///   final String? domain;
 /// }
 /// ```
-/// {@end-tool}
 @immutable
 class WebResourceError {
   /// Used by the platform implementation to create a new [WebResourceError].
diff --git a/packages/webview_flutter/webview_flutter_platform_interface/pubspec.yaml b/packages/webview_flutter/webview_flutter_platform_interface/pubspec.yaml
@@ -4,7 +4,7 @@ repository: https://github.com/flutter/packages/tree/main/packages/webview_flutt
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview_flutter%22
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 2.13.0
+version: 2.13.1
 
 environment:
   sdk: ^3.6.0
