Unverified Commit 997a94fd authored by Michael Goderbauer's avatar Michael Goderbauer Committed by GitHub

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.
parent 5f477642
...@@ -399,17 +399,20 @@ targets: ...@@ -399,17 +399,20 @@ targets:
firebase_project: "" firebase_project: ""
release_ref: "" release_ref: ""
tags: > tags: >
["framework","hostonly", "linux"] ["framework", "hostonly", "linux"]
validation: docs validation: docs
validation_name: Docs validation_name: Docs
runIf: runIf:
- bin/**
- dev/** - dev/**
- packages/flutter/** - packages/flutter/**
- packages/flutter_test/**
- packages/flutter_drive/** - packages/flutter_drive/**
- packages/flutter_localizations/** - packages/flutter_localizations/**
- bin/** - packages/flutter_test/**
- packages/flutter_web_plugins/**
- packages/integration_test/**
- .ci.yaml - .ci.yaml
- dartdoc_options.yaml
- name: Linux engine_dependency_proxy_test - name: Linux engine_dependency_proxy_test
recipe: devicelab/devicelab_drone recipe: devicelab/devicelab_drone
......
...@@ -14,13 +14,12 @@ dartdoc: ...@@ -14,13 +14,12 @@ dartdoc:
command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"] 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." description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad."
errors: errors:
# Default errors of dartdoc: ## Default errors of dartdoc:
- duplicate-file - duplicate-file
- invalid-parameter - invalid-parameter
- no-defining-library-found
- tool-error - tool-error
- unresolved-export - unresolved-export
# Warnings that are elevated to errors: ## Warnings that are elevated to errors:
- ambiguous-doc-reference - ambiguous-doc-reference
- ambiguous-reexport - ambiguous-reexport
- broken-link - broken-link
...@@ -31,10 +30,12 @@ dartdoc: ...@@ -31,10 +30,12 @@ dartdoc:
- no-canonical-found - no-canonical-found
- no-documentable-libraries - no-documentable-libraries
- no-library-level-docs - no-library-level-docs
- not-implemented
- orphaned-file - orphaned-file
- reexported-private-api-across-packages - reexported-private-api-across-packages
# - unknown-directive # Disabled due to https://github.com/dart-lang/dartdoc/issues/2353
- unknown-file - unknown-file
- unknown-macro - unknown-macro
- unresolved-doc-reference - 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
...@@ -111,7 +111,7 @@ function generate_docs() { ...@@ -111,7 +111,7 @@ function generate_docs() {
# Install and activate dartdoc. # Install and activate dartdoc.
# When updating to a new dartdoc version, please also update # When updating to a new dartdoc version, please also update
# `dartdoc_options.yaml` to include newly introduced error and warning types. # `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 # Install and activate the snippets tool, which resides in the
# assets-for-api-docs repo: # assets-for-api-docs repo:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment