From 997a94fd1f022492b6c955013eeec7e4c4e67c62 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Fri, 20 Oct 2023 15:13:28 -0700 Subject: [PATCH] Bump dartdoc to 7.0.1 and clean-up (#136975) These warnings/errors have been removed from dartdoc. Removing them from the flutter config as well. Also fixes CI to actually test doc generation for all documented packages and on dartdoc config changes. --- .ci.yaml | 9 ++++++--- dartdoc_options.yaml | 11 ++++++----- dev/bots/docs.sh | 2 +- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.ci.yaml b/.ci.yaml index 831b3a1c87..9443f9a630 100644 --- a/.ci.yaml +++ b/.ci.yaml @@ -399,17 +399,20 @@ targets: firebase_project: "" release_ref: "" tags: > - ["framework","hostonly", "linux"] + ["framework", "hostonly", "linux"] validation: docs validation_name: Docs runIf: + - bin/** - dev/** - packages/flutter/** - - packages/flutter_test/** - packages/flutter_drive/** - packages/flutter_localizations/** - - bin/** + - packages/flutter_test/** + - packages/flutter_web_plugins/** + - packages/integration_test/** - .ci.yaml + - dartdoc_options.yaml - name: Linux engine_dependency_proxy_test recipe: devicelab/devicelab_drone diff --git a/dartdoc_options.yaml b/dartdoc_options.yaml index f73d4570c3..545194efe0 100644 --- a/dartdoc_options.yaml +++ b/dartdoc_options.yaml @@ -14,13 +14,12 @@ dartdoc: command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"] description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad." errors: - # Default errors of dartdoc: + ## Default errors of dartdoc: - duplicate-file - invalid-parameter - - no-defining-library-found - tool-error - unresolved-export - # Warnings that are elevated to errors: + ## Warnings that are elevated to errors: - ambiguous-doc-reference - ambiguous-reexport - broken-link @@ -31,10 +30,12 @@ dartdoc: - no-canonical-found - no-documentable-libraries - no-library-level-docs - - not-implemented - orphaned-file - reexported-private-api-across-packages - # - unknown-directive # Disabled due to https://github.com/dart-lang/dartdoc/issues/2353 - unknown-file - unknown-macro - unresolved-doc-reference + ## Ignores that are elevated to errors: + # - type-as-html # not yet tested + # - missing-constant-constructor # not yet tested + # - missing-code-block-language # not yet tested diff --git a/dev/bots/docs.sh b/dev/bots/docs.sh index c070086aac..11ae03543a 100755 --- a/dev/bots/docs.sh +++ b/dev/bots/docs.sh @@ -111,7 +111,7 @@ function generate_docs() { # Install and activate dartdoc. # When updating to a new dartdoc version, please also update # `dartdoc_options.yaml` to include newly introduced error and warning types. - "$DART" pub global activate dartdoc 6.3.0 + "$DART" pub global activate dartdoc 7.0.1 # Install and activate the snippets tool, which resides in the # assets-for-api-docs repo: