Analyzer: Finish using ///-style comments.

srawlins · commit-bot@chromium.org · commit bda499448239 · 2020-07-06T00:54:10.000Z
This ignores the Lint on a few files where it is undesired. Change-Id: I5e4244607da0ef60678cebb89a433e44cb1e753f Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/153180 Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
diff --git a/pkg/analyzer/analysis_options.yaml b/pkg/analyzer/analysis_options.yaml
@@ -11,12 +11,6 @@ analyzer:
     omit_local_variable_types: ignore
     # There are currently 3360 violations in lib/.
     prefer_single_quotes: ignore
-    # Ignoring "style" lint rules from pedantic for now. There are pre-existing
-    # violations that need to be cleaned up. Each one can be cleaned up and
-    # enabled according to the value provided.
-    # TODO(srawlins): At the time of writing, 500 violations in lib/. The fix
-    # is mechanical, via `dartfmt --fix-doc-comments`.
-    slash_for_doc_comments: ignore
     # There are currently 2000 violations in lib/.
     unnecessary_this: ignore
 
diff --git a/pkg/analyzer/lib/src/dart/error/ffi_code.dart b/pkg/analyzer/lib/src/dart/error/ffi_code.dart
@@ -6,6 +6,10 @@ import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/error/analyzer_error_code.dart';
 import 'package:meta/meta.dart';
 
+// It is hard to visually separate each code's _doc comment_ from its published
+// _documentation comment_ when each is written as an end-of-line comment.
+// ignore_for_file: slash_for_doc_comments
+
 /// The diagnostic codes associated with `dart:ffi`.
 class FfiCode extends AnalyzerErrorCode {
   /**
diff --git a/pkg/analyzer/lib/src/dart/error/hint_codes.dart b/pkg/analyzer/lib/src/dart/error/hint_codes.dart
@@ -5,6 +5,10 @@
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/error/analyzer_error_code.dart';
 
+// It is hard to visually separate each code's _doc comment_ from its published
+// _documentation comment_ when each is written as an end-of-line comment.
+// ignore_for_file: slash_for_doc_comments
+
 /**
  * The hints and coding recommendations for best practices which are not
  * mentioned in the Dart Language Specification.
diff --git a/pkg/analyzer/lib/src/dart/error/syntactic_errors.dart b/pkg/analyzer/lib/src/dart/error/syntactic_errors.dart
@@ -2,6 +2,10 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+// It is hard to visually separate each code's _doc comment_ from its published
+// _documentation comment_ when each is written as an end-of-line comment.
+// ignore_for_file: slash_for_doc_comments
+
 /**
  * The errors produced during syntactic analysis (scanning and parsing).
  */
diff --git a/pkg/analyzer/lib/src/dart/error/todo_codes.dart b/pkg/analyzer/lib/src/dart/error/todo_codes.dart
@@ -4,6 +4,10 @@
 
 import 'package:analyzer/error/error.dart';
 
+// It is hard to visually separate each code's _doc comment_ from its published
+// _documentation comment_ when each is written as an end-of-line comment.
+// ignore_for_file: slash_for_doc_comments
+
 /**
  * The error code indicating a marker in code for work that needs to be finished
  * or revisited.
diff --git a/pkg/analyzer/lib/src/generated/static_type_analyzer.dart b/pkg/analyzer/lib/src/generated/static_type_analyzer.dart
