Remove the deprecated nodoc option. (#4025)

Author: srawlins

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 9.0.0-wip
 * Remove deprecated `missingCodeBlockLanguage` warning.
 * Remove the deprecated `templates-dir` option.
+* Remove the deprecated `nodoc` option.
 
 ## 8.3.4
 * The URL for category pages now uses _category name_ instead of

lib/src/dartdoc_options.dart

@@ -1207,8 +1207,6 @@ class DartdocOptionContext extends DartdocOptionContextBase
   // ignore: unused_element
   String get _linkToHosted => optionSet['linkTo']['hosted'].valueAt(context);
 
-  List<String> get nodoc => optionSet['nodoc'].valueAt(context);
-
   String get output => optionSet['output'].valueAt(context);
 
   PackageMeta get packageMeta => optionSet['packageMeta'].valueAt(context);
@@ -1501,13 +1499,6 @@ List<DartdocOption> createDartdocOptions(
             help: 'Allow links to be generated for packages outside this one.',
             negatable: true),
       ]),
-    // Deprecated. Use of this option is reported.
-    // TODO(srawlins): Remove.
-    DartdocOptionFileOnly<List<String>>('nodoc', [], resourceProvider,
-        optionIs: OptionKind.glob,
-        help: '(deprecated) Dart symbols declared in these files will be '
-            'treated as though they have the @nodoc directive added to their '
-            'documentation comment.'),
     DartdocOptionArgOnly<String>('output',
         resourceProvider.pathContext.join('doc', 'api'), resourceProvider,
         optionIs: OptionKind.dir, help: 'Path to the output directory.'),

lib/src/generator/templates.runtime_renderers.dart

@@ -25772,7 +25772,6 @@ const _invisibleGetters = {
     'linkToUrl',
     'maxFileCount',
     'maxTotalSize',
-    'nodoc',
     'optionSet',
     'output',
     'packageMeta',

lib/src/model/documentation_comment.dart

@@ -85,15 +85,9 @@ mixin DocumentationComment
   /// dartdoc's generated output.
   ///
   /// An element is considered to be 'nodoc' if any of the following are true:
-  /// * a global 'nodoc' configuration has been set for this element (this
-  ///   feature is deprecated),
   /// * the element has no documentation comment,
   /// * the documentation comment contains the `@nodoc` dartdoc directive.
   late final bool hasNodoc = () {
-    if (packageGraph
-        .configSetsNodocFor(element.library2!.firstFragment.source.fullName)) {
-      return true;
-    }
     if (!hasDocumentationComment) {
       return false;
     }

lib/src/model/package_graph.dart

@@ -905,38 +905,6 @@ class PackageGraph with CommentReferable, Nameable {
     return allElements;
   }
 
-  /// Cache of 'nodoc' configurations.
-  ///
-  /// Glob lookups can be expensive, so cache per filename.
-  final _configSetsNodocFor = HashMap<String, bool>();
-
-  /// Given an element's [fullName], look up the nodoc configuration data and
-  /// determine whether to unconditionally treat the element as "nodoc", an
-  /// attribute indicating that documentation should not be included in
-  /// dartdoc's generated output.
-  ///
-  /// This configuration setting is deprecated.
-  bool configSetsNodocFor(String fullName) {
-    return _configSetsNodocFor.putIfAbsent(fullName, () {
-      var file = resourceProvider.getFile(fullName);
-      // Direct lookup instead of generating a custom context will save some
-      // cycles.  We can't use the element's [DartdocOptionContext] because that
-      // might not be where the element was defined, which is what's important
-      // for nodoc's semantics.  Looking up the defining element just to pull
-      // a context is again, slow.
-      var globs = (config.optionSet['nodoc'].valueAt(file.parent) as List)
-          .cast<String>();
-      if (globs.isNotEmpty) {
-        packageGraph.defaultPackage.warn(
-          PackageWarning.deprecated,
-          message:
-              "The '--nodoc' option is deprecated, and will soon be removed.",
-        );
-      }
-      return utils.matchGlobs(globs, fullName);
-    });
-  }
-
   /// Returns a macro by [name], or `null` if no macro is found.
   String? getMacro(String name) {
     assert(_localDocumentationBuilt);

test/end2end/model_test.dart

@@ -1158,22 +1158,6 @@ void main() async {
       });
     });
 
-    group('Comment processing', () {
-      test('can virtually add nodoc via options file', () {
-        var NodocMeLibrary =
-            packageGraph.defaultPackage.allLibraries.named('nodocme');
-        expect(NodocMeLibrary.hasNodoc, isTrue);
-        var NodocMeImplementation =
-            fakeLibrary.classes.named('NodocMeImplementation');
-        expect(NodocMeImplementation.hasNodoc, isTrue);
-        expect(NodocMeImplementation.isPublic, isFalse);
-        var MeNeitherEvenWithoutADocComment =
-            fakeLibrary.classes.named('MeNeitherEvenWithoutADocComment');
-        expect(MeNeitherEvenWithoutADocComment.hasNodoc, isTrue);
-        expect(MeNeitherEvenWithoutADocComment.isPublic, isFalse);
-      });
-    });
-
     group('doc references', () {
       late final String docsAsHtml;
 

testing/test_package/dartdoc_options.yaml

@@ -7,7 +7,6 @@ dartdoc:
     Unreal:
       markdown: "Unreal.md"
     Real Libraries:
-  nodoc: ["lib/src/nodoc*.dart"]
   tools:
     drill:
       command: ["bin/drill.dart"]

testing/test_package/lib/fake.dart

@@ -79,9 +79,6 @@ import 'mylibpub.dart' as renamedLib2;
 import 'two_exports.dart' show BaseClass;
 export 'src/notadotdartfile';
 
-// Verify that even though reexported, objects don't show in documentation.
-export 'package:test_package/src/nodocme.dart';
-
 // ignore: uri_does_not_exist
 export 'package:test_package_imported/categoryExporting.dart'
     show IAmAClassWithCategories;