Skip to content

Commit

Permalink
Analyzer: Finish using ///-style comments.
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
srawlins authored and commit-bot@chromium.org committed Jul 6, 2020
1 parent 42d2996 commit bda4994
Show file tree
Hide file tree
Showing 6 changed files with 248 additions and 326 deletions.
6 changes: 0 additions & 6 deletions pkg/analyzer/analysis_options.yaml
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions pkg/analyzer/lib/src/dart/error/ffi_code.dart
Expand Up @@ -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 {
/**
Expand Down
4 changes: 4 additions & 0 deletions pkg/analyzer/lib/src/dart/error/hint_codes.dart
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions pkg/analyzer/lib/src/dart/error/syntactic_errors.dart
Expand Up @@ -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).
*/
Expand Down
4 changes: 4 additions & 0 deletions pkg/analyzer/lib/src/dart/error/todo_codes.dart
Expand Up @@ -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.
Expand Down

0 comments on commit bda4994

Please sign in to comment.