docs: add docs and ignores to the code files (#516)

* feat: add docs and ignores to the code files

* docs: add missing docs for summary record

Author: incendial

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'dart:async';
 
 import 'package:analyzer/dart/analysis/context_builder.dart';

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_method.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/type.dart';
 

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_parameter_list.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import '../../../../utils/node_utils.dart';
 import '../../lint_utils.dart';
 import '../../metrics/metric_utils.dart';

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -27,9 +27,12 @@ import 'models/suppression.dart';
 import 'reporters/reporter_factory.dart';
 import 'utils/report_utils.dart';
 
+/// The analyzer responsible for collecting lint reports.
 class LintAnalyzer {
   const LintAnalyzer();
 
+  /// Returns a reporter for the given [name]. Use the reporter
+  /// to convert analysis reports to console, JSON or other supported format.
   Reporter? getReporter({
     required String name,
     required IOSink output,
@@ -43,6 +46,8 @@ class LintAnalyzer {
         reportFolder: reportFolder,
       );
 
+  /// Returns a lint report for analyzing given [result].
+  /// The analysis is configured with the [config].
   LintFileReport? runPluginAnalysis(
     ResolvedUnitResult result,
     LintAnalysisConfig config,
@@ -60,6 +65,8 @@ class LintAnalyzer {
     return null;
   }
 
+  /// Returns a list of lint reports for analyzing all files in the given [folders].
+  /// The analysis is configured with the [config].
   Future<Iterable<LintFileReport>> runCliAnalysis(
     Iterable<String> folders,
     String rootFolder,

lib/src/analyzers/lint_analyzer/lint_config.dart

@@ -24,6 +24,7 @@ class LintConfig {
     required this.antiPatterns,
   });
 
+  /// Creates the config from analysis [options].
   factory LintConfig.fromAnalysisOptions(AnalysisOptions options) {
     const _rootKey = 'dart_code_metrics';
 
@@ -39,6 +40,7 @@ class LintConfig {
     );
   }
 
+  /// Creates the config from cli [arguments].
   factory LintConfig.fromArgs(ParsedArguments arguments) => LintConfig(
         excludePatterns: [arguments.excludePath],
         excludeForMetricsPatterns: const [],
@@ -52,6 +54,10 @@ class LintConfig {
         antiPatterns: const {},
       );
 
+  /// Merges two configs into a single one
+  ///
+  /// Config coming from [overrides] has a higher priority
+  /// and overrides conflicting entries.
   LintConfig merge(LintConfig overrides) => LintConfig(
         excludePatterns: {...excludePatterns, ...overrides.excludePatterns},
         excludeForMetricsPatterns: {

lib/src/analyzers/lint_analyzer/metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_flow_visitor.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/syntactic_entity.dart';
 import 'package:analyzer/dart/ast/token.dart';

lib/src/analyzers/lint_analyzer/metrics/metrics_list/halstead_volume/halstead_volume_ast_visitor.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/ast/visitor.dart';

lib/src/analyzers/lint_analyzer/metrics/metrics_list/maximum_nesting_level/nesting_level_visitor.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 

lib/src/analyzers/lint_analyzer/metrics/scope_visitor.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 

lib/src/analyzers/lint_analyzer/models/internal_resolved_unit_result.dart

@@ -1,6 +1,7 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/source/line_info.dart';
 
+/// Represents a resolved unit from an AST analysis.
 class InternalResolvedUnitResult {
   final String path;
   final String content;