Tidy up LintCode docs before making public API

Work towards #50986 Cq-Include-Trybots: luci.dart.try:flutter-analyze-try,analyzer-win-release-try,pkg-win-release-try Change-Id: I60d378da27570f6b76a554685802d3b888edee0d Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/372182 Reviewed-by: Brian Wilkerson <[email protected]> Commit-Queue: Sam Rawlins <[email protected]>
dart-lang · Jun 20, 2024 · ae3de54 · ae3de54
1 parent 705c745
commit ae3de54
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/pkg/analyzer/lib/src/dart/error/lint_codes.dart b/pkg/analyzer/lib/src/dart/error/lint_codes.dart
@@ -2,13 +2,17 @@
 // 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.
 
+/// @docImport 'package:analyzer/src/error/codes.g.dart';
+library;
+
 import 'package:analyzer/error/error.dart';
 
 /// Defines style and best practice recommendations.
 ///
-/// Unlike [HintCode]s, which are akin to traditional static warnings from a
-/// compiler, lint recommendations focus on matters of style and practices that
-/// might aggregated to define a project's style guide.
+/// Unlike [WarningCode]s, which are akin to traditional static warnings from a
+/// compiler, lint recommendations focus on matters of avoiding errors,
+/// unintended code, maintainability, style and other best practices that might
+/// be aggregated to define a project's style guide.
 class LintCode extends ErrorCode {
   const LintCode(
     String name,