Fix some broken comment references. (#9037)

srawlins · web-flow · commit 87f8016e2610 · 2025-03-17T13:06:07.000-07:00
diff --git a/packages/devtools_app/lib/src/screens/performance/performance_controller.dart b/packages/devtools_app/lib/src/screens/performance/performance_controller.dart
@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
+/// @docImport 'tabbed_performance_view.dart';
+library;
+
 import 'dart:async';
 
 import 'package:devtools_app_shared/service.dart';
diff --git a/packages/devtools_app/lib/src/screens/vm_developer/vm_service_private_extensions.dart b/packages/devtools_app/lib/src/screens/vm_developer/vm_service_private_extensions.dart
@@ -4,6 +4,9 @@
 
 // ignore_for_file: constant_identifier_names
 
+/// @docImport '../../shared/preferences/preferences.dart';
+library;
+
 import 'package:flutter/widgets.dart';
 import 'package:vm_service/vm_service.dart';
 
diff --git a/packages/devtools_app/lib/src/service/service_extension_widgets.dart b/packages/devtools_app/lib/src/service/service_extension_widgets.dart
@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
+/// @docImport 'package:vm_service/vm_service.dart';
+library;
+
 import 'dart:async';
 import 'dart:math' as math;
 
@@ -408,7 +411,7 @@ class StructuredErrorsToggle extends StatelessWidget {
 
 /// [Switch] that stays synced with the value of a service extension.
 ///
-/// Service extensions can be found in [service_extensions.dart].
+/// Service extensions can be found in `service_extensions.dart`.
 class _ServiceExtensionToggle extends ServiceExtensionWidget {
   const _ServiceExtensionToggle({
     required this.service,
@@ -492,7 +495,7 @@ class _ServiceExtensionToggleState extends State<_ServiceExtensionToggle>
 
 /// [Checkbox] that stays synced with the value of a service extension.
 ///
-/// Service extensions can be found in [service_extensions.dart].
+/// Service extensions can be found in `service_extensions.dart`.
 class ServiceExtensionCheckbox extends ServiceExtensionWidget {
   ServiceExtensionCheckbox({
     super.key,
@@ -927,12 +930,12 @@ abstract class ServiceExtensionWidget extends StatefulWidget {
 
   /// The text to show when the action is completed.
   ///
-  /// This will be shown in a [SnackBar], replacing the [inProgressText].
+  /// This will be shown in a [SnackBar], replacing the `inProgressText`.
   final String? completedText;
 
   /// Callback that describes any error that occurs.
   ///
-  /// This will replace the [inProgressText] in a [SnackBar].
+  /// This will replace the `inProgressText` in a [SnackBar].
   final String Function(Object? error) describeError;
 
   @override
diff --git a/packages/devtools_app/lib/src/service/vm_service_wrapper.dart b/packages/devtools_app/lib/src/service/vm_service_wrapper.dart
@@ -5,6 +5,9 @@
 // Code needs to match API from VmService.
 // ignore_for_file: avoid-dynamic
 
+/// @docImport '../shared/preferences/preferences.dart';
+library;
+
 import 'dart:async';
 import 'dart:convert';
 
diff --git a/packages/devtools_app/lib/src/shared/analytics/analytics_common.dart b/packages/devtools_app/lib/src/shared/analytics/analytics_common.dart
@@ -5,6 +5,9 @@
 // Code in this file should be able to be imported by both web and dart:io
 // dependent libraries.
 
+/// @docImport '_analytics_web.dart';
+library;
+
 import 'package:collection/collection.dart';
 import 'package:flutter/widgets.dart';
 import 'package:stack_trace/stack_trace.dart' as stack_trace;
@@ -35,10 +38,10 @@ const ga4ParamValueCharacterLimit = 100;
 
 /// Returns a stack trace as a [Map] for consumption by GA4 analytics.
 ///
-/// The returned [Map] is indexed into [stackTraceChunksLimit] chunks, where
+/// The returned [Map] is indexed into `stackTraceChunksLimit` chunks, where
 /// each chunk is a substring of length [ga4ParamValueCharacterLimit]. Each
 /// substring contains information for ~1 stack frame, so including
-/// [stackTraceChunksLimit] chunks should give us enough information to
+/// `stackTraceChunksLimit` chunks should give us enough information to
 /// understand the source of the exception.
 ///
 /// This method uses a heuristic to attempt to include a minimal amount of
diff --git a/packages/devtools_app/lib/src/shared/analytics/constants.dart b/packages/devtools_app/lib/src/shared/analytics/constants.dart
@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
+/// @docImport '../../extensions/extension_screen_controls.dart';
+library;
+
 import 'package:devtools_shared/devtools_extensions.dart';
 
 import '../framework/screen.dart';
diff --git a/packages/devtools_app/lib/src/shared/analytics/constants/_extension_constants.dart b/packages/devtools_app/lib/src/shared/analytics/constants/_extension_constants.dart
@@ -20,7 +20,7 @@ enum DevToolsExtensionEvents {
   /// an extension has been enabled.
   embeddedExtension;
 
-  /// Event sent via [ga.screen] when an extension screen is opened.
+  /// Event sent via `ga.screen` when an extension screen is opened.
   static String extensionScreenName(DevToolsExtensionConfig ext) =>
       'extension-${ext.analyticsSafeName}';
 
diff --git a/packages/devtools_app/lib/src/shared/analytics/metrics.dart b/packages/devtools_app/lib/src/shared/analytics/metrics.dart
@@ -2,6 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
+/// @docImport '../../screens/inspector/inspector_tree_controller.dart';
+/// @docImport '../../screens/performance/panes/flutter_frames/flutter_frame_model.dart';
+library;
+
 import 'analytics_common.dart';
 
 class MemoryScreenMetrics extends ScreenAnalyticsMetrics {
diff --git a/packages/devtools_app/lib/src/shared/charts/flame_chart.dart b/packages/devtools_app/lib/src/shared/charts/flame_chart.dart
@@ -1003,7 +1003,7 @@ class FlameChartRow<T extends FlameChartDataMixin<T>> {
 
   final int index;
 
-  /// Adds a node to [nodes] and assigns [this] to the nodes [row] property.
+  /// Adds a node to [nodes] and assigns `this` to the node's `row` property.
   ///
   /// If [index] is specified and in range of the list, [node] will be added at
   /// [index]. Otherwise, [node] will be added to the end of [nodes]
diff --git a/packages/devtools_app/lib/src/shared/charts/treemap.dart b/packages/devtools_app/lib/src/shared/charts/treemap.dart
@@ -755,7 +755,7 @@ class TreemapNode extends TreeNode<TreemapNode> {
     return '$plusSign${prettyPrintBytes(byteSize, includeUnit: true)}';
   }
 
-  /// Returns a list of [TreemapNode] in the path from root node to [this].
+  /// Returns a list of [TreemapNode] in the path from root node to `this`.
   List<TreemapNode> pathFromRoot() {
     TreemapNode? node = this;
     final path = <TreemapNode>[];
diff --git a/packages/devtools_app/lib/src/shared/config_specific/drag_and_drop/drag_and_drop.dart b/packages/devtools_app/lib/src/shared/config_specific/drag_and_drop/drag_and_drop.dart
@@ -194,8 +194,7 @@ class DragAndDropState extends State<DragAndDrop> {
 /// [DragAndDropEventAbsorber]).
 ///
 /// Drag and drop widgets will contain a [MetaData] widget with the `metaData`
-/// field set to an instance of this class. [value] must be a unique identifier
-/// for [DragAndDrop] widgets.
+/// field set to an instance of this class.
 class DragAndDropMetaData {
   const DragAndDropMetaData({required this.state});
 
diff --git a/packages/devtools_app/lib/src/shared/console/eval/inspector_tree.dart b/packages/devtools_app/lib/src/shared/console/eval/inspector_tree.dart
@@ -180,8 +180,6 @@ class InspectorTreeNode {
 
   // TODO(jacobr): move this method to the InspectorTree class.
   // TODO: optimize this method.
-  /// Use [getCachedRow] wherever possible, as [getRow] is slow and can cause
-  /// performance problems.
   InspectorTreeRow? getRow(int index) {
     if (subtreeSize <= index) {
       return null;
diff --git a/packages/devtools_app/lib/src/shared/development_helpers.dart b/packages/devtools_app/lib/src/shared/development_helpers.dart
@@ -48,7 +48,7 @@ bool debugShowAnalyticsConsentMessage = false;
 
 /// Whether to build DevTools for conveniently debugging DevTools extensions.
 ///
-/// Turning this flag to [true] allows for debugging the extensions framework
+/// Turning this flag to `true` allows for debugging the extensions framework
 /// without a server connection.
 ///
 /// This flag should never be checked in with a value of true - this is covered
diff --git a/packages/devtools_app/lib/src/shared/primitives/graph.dart b/packages/devtools_app/lib/src/shared/primitives/graph.dart
@@ -23,7 +23,7 @@ class GraphNode {
   final successors = <GraphNode>{};
 
   /// Maps predecessor [GraphNode]s from [predecessors] to the number of
-  /// outgoing edges going to [this] node.
+  /// outgoing edges going to `this` node.
   ///
   /// For example:
   ///        A (predecessor node)
@@ -36,7 +36,7 @@ class GraphNode {
   final predecessorEdgeCounts = <GraphNode, int>{};
 
   /// Maps successor [GraphNode]s from [successors] to the number of incoming
-  /// edges coming from [this] node.
+  /// edges coming from `this` node.
   ///
   /// For example:
   ///        A (this node)
@@ -68,7 +68,7 @@ class GraphNode {
     return 0.0;
   }
 
-  /// Create outgoing edge from [this] node to the given node [n].
+  /// Create outgoing edge from `this` node to the given node [n].
   void outgoingEdge(GraphNode n, {int edgeWeight = 1}) {
     n.predecessors.add(this);
     final predEdgeCount = n.predecessorEdgeCounts[this] ?? 0;
diff --git a/packages/devtools_app/lib/src/shared/primitives/trees.dart b/packages/devtools_app/lib/src/shared/primitives/trees.dart
@@ -22,10 +22,10 @@ abstract class TreeNode<T extends TreeNode<T>> {
   // TODO(jacobr) should impact depth.
   bool indentChildren = true;
 
-  /// Index in [parent.children].
+  /// Index in `parent.children`.
   int index = -1;
 
-  /// Depth of this tree, including [this].
+  /// Depth of this tree, including `this`.
   ///
   /// We assume that TreeNodes are not modified after the first time [depth] is
   /// accessed. We would need to clear the cache before accessing, otherwise.
@@ -206,7 +206,7 @@ abstract class TreeNode<T extends TreeNode<T>> {
 
   /// Locates the first sub-node in the tree at level [level].
   ///
-  /// [level] is relative to the subtree root [this].
+  /// [level] is relative to the subtree root `this`.
   ///
   /// For example:
   ///
@@ -233,7 +233,7 @@ abstract class TreeNode<T extends TreeNode<T>> {
 
   /// Locates the last sub-node in the tree at level [level].
   ///
-  /// [level] is relative to the subtree root [this].
+  /// [level] is relative to the subtree root `this`.
   ///
   /// For example:
   ///
@@ -288,8 +288,8 @@ abstract class TreeNode<T extends TreeNode<T>> {
   /// Filters a tree starting at this node and returns a list of new roots after
   /// filtering, where all nodes in the new tree(s) meet the condition `filter`.
   ///
-  /// If the root [this] should be included in the filtered results, the list
-  /// will contain one node. If the root [this] should not be included in the
+  /// If the root `this` should be included in the filtered results, the list
+  /// will contain one node. If the root `this` should not be included in the
   /// filtered results, the list may contain one or more nodes.
   List<T> filterWhere(bool Function(T node) filter) {
     List<T> walkAndCopy(T node) {
diff --git a/packages/devtools_app/lib/src/shared/primitives/utils.dart b/packages/devtools_app/lib/src/shared/primitives/utils.dart
@@ -949,7 +949,7 @@ extension StringExtension on String {
     );
   }
 
-  /// Whether [other] is a case insensitive match for this String.
+  /// Whether [pattern] is a case insensitive match for this String.
   ///
   /// If [pattern] is a [RegExp], this method will return true if and only if
   /// this String is a complete [RegExp] match, meaning that the regular
diff --git a/packages/devtools_app/lib/src/shared/table/_tree_table.dart b/packages/devtools_app/lib/src/shared/table/_tree_table.dart
@@ -18,7 +18,7 @@ enum TreeTableScrollKind { up, down, parent }
 /// list of the tree hierarchy. It then uses the nesting level of the
 /// deepest row in [dataRoots] to determine how wide to make the [treeColumn].
 ///
-/// If [dataRoots.length] > 1, there are multiple trees in this tree table. In
+/// If `dataRoots.length` > 1, there are multiple trees in this tree table. In
 /// this case, tree table operations (expand all, collapse all, sort, etc.) will
 /// be applied to every tree.
 class TreeTable<T extends TreeNode<T>> extends StatefulWidget {
diff --git a/packages/devtools_app/lib/src/shared/table/table_controller.dart b/packages/devtools_app/lib/src/shared/table/table_controller.dart
@@ -297,12 +297,12 @@ abstract class TableControllerBase<T> extends DisposableController {
 
   final _tableData = ValueNotifier<TableData<T>>(TableData<T>.empty());
 
-  /// The pinned data for the active data set [_tableData.value].
+  /// The pinned data for the active data set `_tableData.value`.
   ///
   /// This value is reset each time [sortDataAndNotify] is called.
   late List<T> pinnedData;
 
-  /// Returns the [TableUiState] for the current data [_tableData.value].
+  /// Returns the [TableUiState] for the current data `_tableData.value`.
   TableUiState get tableUiState => _tableUiStateForKey(_currentDataKey);
 
   /// This method should be overridden by all subclasses.
diff --git a/packages/devtools_app/lib/src/shared/utils/future_work_tracker.dart b/packages/devtools_app/lib/src/shared/utils/future_work_tracker.dart
@@ -29,10 +29,10 @@ class FutureWorkTracker {
     _active.value = false;
   }
 
-  /// Adds [future] to the work being tracked.
+  /// Adds [futureCallback] to the work being tracked.
   ///
-  /// Unless [clear] is called, [active] will now return true until [future]
-  /// completes either with a value or an error.
+  /// Unless [clear] is called, [active] will now return true until
+  /// [futureCallback] completes either with a value or an error.
   Future<Object?> track(
     Future<Object?> Function() futureCallback, {
     int delayMicros = 0,
diff --git a/packages/devtools_app/lib/src/shared/utils/profiler_utils.dart b/packages/devtools_app/lib/src/shared/utils/profiler_utils.dart
@@ -128,7 +128,7 @@ class ProfileMetaData {
 /// Process for converting a [ProfilableDataMixin] into a bottom-up
 /// representation of the profile.
 ///
-/// [rootedAtTags] specifies whether or not the top-down tree is rooted
+/// `rootedAtTags` specifies whether or not the top-down tree is rooted
 /// at synthetic nodes representing user / VM tags.
 class BottomUpTransformer<T extends ProfilableDataMixin<T>> {
   Future<List<T>> bottomUpRootsFor({

Original file line number	Diff line number	Diff line change
`@@ -755,7 +755,7 @@ class TreemapNode extends TreeNode<TreemapNode> {`
`755`	`755`	`return '$plusSign${prettyPrintBytes(byteSize, includeUnit: true)}';`
`756`	`756`	`}`
`757`	`757`
`758`		`- /// Returns a list of [TreemapNode] in the path from root node to [this].`
	`758`	+ /// Returns a list of [TreemapNode] in the path from root node to `this`.
`759`	`759`	`List<TreemapNode> pathFromRoot() {`
`760`	`760`	`TreemapNode? node = this;`
`761`	`761`	`final path = <TreemapNode>[];`