Skip to content

Commit 2c5d209

Browse files
authored
Resolve all remaining broken comment references (#9074)
1 parent c8eedf7 commit 2c5d209

29 files changed

Lines changed: 104 additions & 100 deletions

File tree

analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ linter:
6767
- cancel_subscriptions
6868
# - cascade_invocations # not yet tested
6969
# - close_sinks # https://github.com/flutter/flutter/issues/5789
70-
# - comment_references # blocked on https://github.com/dart-lang/dartdoc/issues/1153
70+
- comment_references
7171
# - constant_identifier_names # https://github.com/dart-lang/linter/issues/204
7272
- control_flow_in_finally
7373
- directives_ordering

packages/devtools_app/lib/src/extensions/extension_service.dart

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,16 @@ final _log = Logger('ExtensionService');
2020
/// visible extensions.
2121
typedef DevToolsExtensionsGroup =
2222
({
23-
/// All the DevTools extensions, runtime and static, that are available for
24-
/// the connected application, regardless of whether they have been enabled or
25-
/// disabled by the user.
26-
///
27-
/// This set of extensions will include one version of a DevTools extension
28-
/// per package and will exclude any duplicates that have been marked as
29-
/// ignored in [_maybeIgnoreExtensions].
23+
// All the DevTools extensions, runtime and static, that are available for
24+
// the connected application, regardless of whether they have been enabled
25+
// or disabled by the user.
26+
//
27+
// This set of extensions will include one version of a DevTools extension
28+
// per package.
3029
List<DevToolsExtensionConfig> availableExtensions,
3130

32-
/// DevTools extensions that are visible in their own DevTools screen (i.e.
33-
/// extensions that have not been manually disabled by the user).
31+
// DevTools extensions that are visible in their own DevTools screen (i.e.
32+
// extensions that have not been manually disabled by the user).
3433
List<DevToolsExtensionConfig> visibleExtensions,
3534
});
3635

@@ -71,8 +70,7 @@ class ExtensionService extends DisposableController
7170
/// disabled by the user.
7271
///
7372
/// This set of extensions will include one version of a DevTools extension
74-
/// per package and will exclude any duplicates that have been marked as
75-
/// ignored in [_maybeIgnoreExtensions].
73+
/// per package.
7674
List<DevToolsExtensionConfig> get availableExtensions =>
7775
_currentExtensions.value.availableExtensions;
7876

packages/devtools_app/lib/src/shared/analytics/_analytics_web.dart

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -676,9 +676,7 @@ String? _lastGaError;
676676
/// Reports an error to analytics.
677677
///
678678
/// [errorMessage] is the description of the error.
679-
/// [stackTraceSubstrings] is the stack trace broken up into substrings of
680-
/// size [ga4ParamValueCharacterLimit] so that we can send the stack trace in
681-
/// chunks to GA4 through unified_analytics.
679+
/// [stackTrace] is the stack trace.
682680
void reportError(
683681
String errorMessage, {
684682
stack_trace.Trace? stackTrace,

packages/devtools_app/lib/src/shared/config_specific/drag_and_drop/drag_and_drop.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,7 @@ class DragAndDropState extends State<DragAndDrop> {
191191
}
192192
}
193193

194-
/// MetaData for widgets related to drag and drop functionality ([DragAndDrop],
195-
/// [DragAndDropEventAbsorber]).
194+
/// MetaData for widgets related to drag and drop functionality ([DragAndDrop]).
196195
///
197196
/// Drag and drop widgets will contain a [MetaData] widget with the `metaData`
198197
/// field set to an instance of this class.

packages/devtools_app/lib/src/shared/offline/offline_data.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ class OfflineDataController {
4141
/// Stores the [ConnectedApp] instance temporarily while switching between
4242
/// offline and online modes.
4343
///
44-
/// We store this because the [serviceManager] is a global manager and expects
45-
/// only one connected app. So we swap out the online connected app with the
46-
/// offline app data while in offline mode.
44+
/// We store this because the `serviceConnection.serviceManager` is a global
45+
/// manager and expects only one connected app. So we swap out the online
46+
/// connected app with the offline app data while in offline mode.
4747
ConnectedApp? previousConnectedApp;
4848

4949
/// Whether DevTools should load offline data for [screenId].

packages/devtools_app/lib/src/shared/primitives/graph.dart

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,30 @@ class GraphNode {
2626
/// outgoing edges going to `this` node.
2727
///
2828
/// For example:
29+
/// ```none
2930
/// A (predecessor node)
3031
/// / \
3132
/// | |
3233
/// \ /
3334
/// B (this node)
3435
///
3536
/// ==> successorEdgeCounts[A] = 2
37+
/// ```
3638
final predecessorEdgeCounts = <GraphNode, int>{};
3739

3840
/// Maps successor [GraphNode]s from [successors] to the number of incoming
3941
/// edges coming from `this` node.
4042
///
4143
/// For example:
44+
/// ```none
4245
/// A (this node)
4346
/// / \
4447
/// | |
4548
/// \ /
4649
/// B (successor node)
4750
///
4851
/// ==> successorEdgeCounts[B] = 2
52+
/// ```
4953
final successorEdgeCounts = <GraphNode, int>{};
5054

5155
/// Returns the percentage of this node's predecessor edges that connect to

packages/devtools_app/lib/src/shared/table/table.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ class DevToolsTableState<T> extends State<DevToolsTable<T>>
119119

120120
late List<T> _data;
121121

122-
/// An adjusted copy of [widget.columnWidths] where any variable width columns
122+
/// An adjusted copy of `widget.columnWidths` where any variable width columns
123123
/// may be increased so that the sum of all column widths equals the available
124124
/// screen space.
125125
///

packages/devtools_app/lib/src/shared/table/table_controller.dart

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
// Copyright 2025 The Flutter Authors
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
4+
5+
/// @docImport 'table.dart';
6+
library;
7+
48
import 'dart:collection';
59
import 'dart:math';
610

@@ -56,13 +60,13 @@ class FlatTableController<T> extends TableControllerBase<T> {
5660
/// Callback that will be called after each table sort operation.
5761
final VoidCallback? onDataSorted;
5862

59-
/// The unmodified, original data for the active data set [_tableData.value].
63+
/// The unmodified, original data for the active data set `_tableData.value`.
6064
///
6165
/// This is reset each time [setData] is called, when [sortOriginalData] is
6266
/// false.
6367
late UnmodifiableListView<T> _unmodifiableOriginalData;
6468

65-
/// The modifiable, original data for the active data set [_tableData.value].
69+
/// The modifiable, original data for the active data set `_tableData.value`.
6670
///
6771
/// This is reset each time [setData] is called, when [sortOriginalData] is
6872
/// true.
@@ -255,16 +259,16 @@ abstract class TableControllerBase<T> extends DisposableController {
255259
/// dividing lines will be drawn for each column group boundary.
256260
final bool includeColumnGroupHeaders;
257261

258-
/// The default sort column for tables using this [TableController].
262+
/// The default sort column for tables using this TableController.
259263
///
260264
/// The currently active sort column will be stored as part of the
261-
/// [TableUiState] for the current data (stored in [_tableUiStateByData]).
265+
/// [TableUiState] for the current data.
262266
final ColumnData<T> defaultSortColumn;
263267

264-
/// The default [SortDirection] for tables using this [TableController].
268+
/// The default [SortDirection] for tables using this TableController.
265269
///
266270
/// The currently active [SortDirection] will be stored as part of the
267-
/// [TableUiState] for the current data (stored in [_tableUiStateByData]).
271+
/// [TableUiState] for the current data.
268272
final SortDirection defaultSortDirection;
269273

270274
/// The column to be used by the table sorting algorithm to break a tie for
@@ -289,7 +293,7 @@ abstract class TableControllerBase<T> extends DisposableController {
289293
/// The key for the current table data.
290294
///
291295
/// The value assigned to [TableData.key] will only be used if
292-
/// [persistUiStates] has been set to true. Otherwise, all data sets will be
296+
/// `persistUiStates` has been set to true. Otherwise, all data sets will be
293297
/// assigned to and looked up from the key [TableData.defaultDataKey].
294298
String get _currentDataKey => _tableData.value.key;
295299

packages/devtools_app/lib/src/shared/table/table_data.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import '../primitives/utils.dart';
1515
/// not manage any stateful data. The table controllers expect columns to be
1616
/// solely responsible for declaring how to layout table data.
1717
///
18-
/// Any data that can't be stored on the [dataObject] may be accessed by passing
18+
/// Any data that can't be stored on the `dataObject` may be accessed by passing
1919
/// a long-living controller to the constructor of the [ColumnData] subclass.
2020
///
2121
/// The controller is expected to be alive for the duration of the app

packages/devtools_app/lib/src/shared/ui/common_widgets.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1939,7 +1939,7 @@ class ElevatedCard extends StatelessWidget {
19391939
/// [AutomaticKeepAliveClientMixin] on its [State].
19401940
///
19411941
/// Wrap a widget in this class if you want [child] to stay alive, and avoid
1942-
/// rebuilding. This is useful for children of [TabView]s. When wrapped in this
1942+
/// rebuilding. This is useful for children of TabViews. When wrapped in this
19431943
/// wrapper, [child] will not be destroyed and rebuilt when switching tabs.
19441944
///
19451945
/// See [AutomaticKeepAliveClientMixin] for more information.

0 commit comments

Comments
 (0)