Fix a few diagnostics in anticipation of lints v5

parlough · parlough · commit afd95da0e930 · 2024-11-22T13:06:49.000+08:00
diff --git a/dwds/lib/src/debugging/inspector.dart b/dwds/lib/src/debugging/inspector.dart
@@ -692,7 +692,8 @@ class AppInspector implements AppInspectorInterface {
     return _instanceHelper.metadataHelper.isNativeJsError(instanceRef.classRef);
   }
 
-  /// Request and cache <ScriptRef>s for all the scripts in the application.
+  /// Request and cache `<ScriptRef>` tags for all the
+  /// scripts in the application.
   ///
   /// This populates [_scriptRefsById], [_scriptIdToLibraryId],
   /// [_libraryIdToScriptRefs] and [_serverPathToScriptRef].
diff --git a/dwds/lib/src/debugging/metadata/class.dart b/dwds/lib/src/debugging/metadata/class.dart
@@ -90,15 +90,15 @@ class ClassMetaData {
 
   /// Type name for Type instances.
   ///
-  /// For example, 'int', 'String', 'MyClass', 'List<int>'.
+  /// For example: `'int'`, `'String'`, `'MyClass'`, `'List<int>'`.
   final String? typeName;
 
   /// The length of the object, if applicable.
   final int? length;
 
   /// The dart type name for the object.
   ///
-  /// For example, 'int', 'List<String>', 'Null'
+  /// For example: `'int'`, `'List<String>'`, `'Null'`.
   String? get dartName => classRef.name;
 
   /// Class ref for the class metadata.
diff --git a/dwds/lib/src/readers/asset_reader.dart b/dwds/lib/src/readers/asset_reader.dart
@@ -11,7 +11,7 @@ import 'package:package_config/package_config.dart';
 abstract class AssetReader {
   /// Base path of the application, for example, set up in the index file:
   ///
-  /// ```
+  /// ```html
   /// <html>
   ///   <head>
   ///     <base href="/abc/">
diff --git a/dwds/lib/src/services/expression_evaluator.dart b/dwds/lib/src/services/expression_evaluator.dart
@@ -45,10 +45,11 @@ class ExpressionEvaluator {
   static final _syntheticNameFilterRegex =
       RegExp('org-dartlang-debug:synthetic_debug_expression:.*:.*Error: ');
 
-  /// Find module path from the XHR call network error message received from chrome.
+  /// Find module path from the XHR call network error message
+  /// received from chrome.
   ///
   /// Example:
-  /// NetworkError: Failed to load 'http://<hostname>.com/path/to/module.js?<cache_busting_token>'
+  /// `NetworkError: Failed to load 'http://<hostname>.com/path/to/module.js?<cache_busting_token>'`
   static final _loadModuleErrorRegex =
       RegExp(r".*Failed to load '.*\.com/(.*\.js).*");
 
diff --git a/dwds/test/fixtures/project.dart b/dwds/test/fixtures/project.dart
@@ -47,8 +47,8 @@ class TestProject {
         ),
       );
 
-  /// The URI for the package_config.json is located in:
-  /// <project directory>/.dart_tool/package_config
+  /// The URI for the `package_config.json` is located in:
+  /// `<project directory>/.dart_tool/package_config`.
   Uri get packageConfigFile => p.toUri(
         p.join(
           absolutePackageDirectory,

Original file line number	Diff line number	Diff line change
`@@ -692,7 +692,8 @@ class AppInspector implements AppInspectorInterface {`
`692`	`692`	`return _instanceHelper.metadataHelper.isNativeJsError(instanceRef.classRef);`
`693`	`693`	`}`
`694`	`694`
`695`		`- /// Request and cache <ScriptRef>s for all the scripts in the application.`
	`695`	+ /// Request and cache `<ScriptRef>` tags for all the
	`696`	`+ /// scripts in the application.`
`696`	`697`	`///`
`697`	`698`	`/// This populates [_scriptRefsById], [_scriptIdToLibraryId],`
`698`	`699`	`/// [_libraryIdToScriptRefs] and [_serverPathToScriptRef].`