Merge branch 'main' into feat/package-web

.github/workflows/scorecards-analysis.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+        uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
         with:
           persist-credentials: false
 

.github/workflows/test.yaml

@@ -66,7 +66,7 @@ jobs:
       - name: Configure git
         if: runner.os == 'Windows'
         run: git config --global core.autocrlf input
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
       - uses: dart-lang/setup-dart@fedb1266e91cf51be2fdb382869461a434b920a3
         with:
           sdk: ${{ matrix.sdk }}

CHANGELOG.md

@@ -1,7 +1,12 @@
-## 8.0.7-wip
+## 8.0.7
 
+* Generate documentation for static members of enums. (#3697)
+* Display an extension's extended type in a few places. (#3708)
+* Minimal support for documenting a package with macro applications. (#3687)
 * Deprecate the `--nodoc` option. (#3690)
 * Deprecate the `--resources-dir` option. (#3696)
+* Deprecate the `--include-externals` option. (#3694)
+* Remove the warning regarding unresolved exports; these are handled by the analyzer. (#3711)
 
 ## 8.0.6
 

README.md

@@ -124,7 +124,6 @@ dartdoc:
       markdown: doc/Second.md
       name: Great
   categoryOrder: ["First Category", "Second Category"]
-  examplePathPrefix: 'subdir/with/examples'
   includeExternal: ['bin/unusually_located_library.dart']
   nodoc: ['lib/sekret/*.dart']
   linkTo:
@@ -150,8 +149,6 @@ Unrecognized options will be ignored.  Supported options:
     defined in dartdoc_options.yaml, those declared categories in the source code will be invisible.
   * **categoryOrder**:  Specify the order of topics for display in the sidebar and
     the package page.
-  * **examplePathPrefix**: Specify the location of the example directory for resolving `@example`
-    directives.
   * **exclude**:  Specify a list of library names to avoid generating docs for,
     overriding any specified in include.  All libraries listed must be local to this package, unlike
     the command line `--exclude`.  See also `nodoc`.

dartdoc_options.yaml

@@ -1,4 +1,4 @@
 dartdoc:
   linkToSource:
     root: '.'
-    uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v8.0.7-wip/%f%#L%l%'
+    uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v8.0.7/%f%#L%l%'

doc/directives.md

@@ -28,27 +28,6 @@ own documentation page, listing all of the categorized elements.
 
 TODO(srawlins): Document.
 
-## `{@example}` - Examples (deprecated)
-
-Examples from the file system can be inlined by using the `{@example}`
-directive. The file path, the region, and the example language can all be
-specified with the following syntax:
-
-```none
-/// {@example PATH [region=NAME] [lang=NAME]}
-```
-
-All example file names must have the extension, `.md`, and this extension must
-not be specified in the example `PATH`. `PATH` must be specified as a relative
-path from the root of the project for which documentation is being generated.
-Given `dir/file.dart` as `PATH`, an example will be extracted from
-`dir/file.dart.md`, relative to the project root directory.
-
-During doc generation, dartdoc will replace the `{@example}` directive with the
-contents of the example file, verbatim.
-
-TODO(srawlins): Document region, lang, `--example-path-prefix`.
-
 ## `{@inject-html}` - Injected HTML
 
 HTML can be rendered unmodified by including it between `{@inject-html}` and

lib/src/dartdoc.dart

@@ -225,7 +225,6 @@ class Dartdoc {
     if (config.showStats) {
       logInfo(runtimeStats.buildReport());
     }
-    await packageBuilder.dispose();
     return DartdocResults(config.topLevelPackageMeta, packageGraph, _outputDir);
   }
 

lib/src/dartdoc_options.dart

@@ -1293,10 +1293,6 @@ class DartdocOptionContext extends DartdocOptionContextBase
   CategoryConfiguration get categories =>
       optionSet['categories'].valueAt(context);
 
-  // TODO(srawlins): Remove when we remove support for `{@example}`.
-  String? get examplePathPrefix =>
-      optionSet['examplePathPrefix'].valueAt(context);
-
   // TODO(srawlins): This memoization saved a lot of time in unit testing, but
   // is the first value in this class to be memoized. Memoize others?
   late final Set<String> exclude =
@@ -1554,12 +1550,6 @@ List<DartdocOption> createDartdocOptions(
         convertYamlToType: CategoryConfiguration.fromYamlMap,
         help: 'A list of all categories, their display names, and markdown '
             'documentation in the order they are to be displayed.'),
-    // TODO(srawlins): Remove when we remove support for `{@example}`.
-    DartdocOptionArgFile<String?>('examplePathPrefix', null, resourceProvider,
-        optionIs: OptionKind.dir,
-        help: '(deprecated) Prefix for @example paths; defaults to the project '
-            'root.',
-        mustExist: true),
     DartdocOptionArgFile<List<String>>('exclude', [], resourceProvider,
         help: 'Names of libraries to exclude from documentation.',
         splitCommas: true),