Skip to content

Commit 997a94f

Browse files
authored
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.
1 parent 5f47764 commit 997a94f

3 files changed

Lines changed: 13 additions & 9 deletions

File tree

.ci.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -399,17 +399,20 @@ targets:
399399
firebase_project: ""
400400
release_ref: ""
401401
tags: >
402-
["framework","hostonly", "linux"]
402+
["framework", "hostonly", "linux"]
403403
validation: docs
404404
validation_name: Docs
405405
runIf:
406+
- bin/**
406407
- dev/**
407408
- packages/flutter/**
408-
- packages/flutter_test/**
409409
- packages/flutter_drive/**
410410
- packages/flutter_localizations/**
411-
- bin/**
411+
- packages/flutter_test/**
412+
- packages/flutter_web_plugins/**
413+
- packages/integration_test/**
412414
- .ci.yaml
415+
- dartdoc_options.yaml
413416

414417
- name: Linux engine_dependency_proxy_test
415418
recipe: devicelab/devicelab_drone

dartdoc_options.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@ dartdoc:
1414
command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"]
1515
description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad."
1616
errors:
17-
# Default errors of dartdoc:
17+
## Default errors of dartdoc:
1818
- duplicate-file
1919
- invalid-parameter
20-
- no-defining-library-found
2120
- tool-error
2221
- unresolved-export
23-
# Warnings that are elevated to errors:
22+
## Warnings that are elevated to errors:
2423
- ambiguous-doc-reference
2524
- ambiguous-reexport
2625
- broken-link
@@ -31,10 +30,12 @@ dartdoc:
3130
- no-canonical-found
3231
- no-documentable-libraries
3332
- no-library-level-docs
34-
- not-implemented
3533
- orphaned-file
3634
- reexported-private-api-across-packages
37-
# - unknown-directive # Disabled due to https://github.com/dart-lang/dartdoc/issues/2353
3835
- unknown-file
3936
- unknown-macro
4037
- unresolved-doc-reference
38+
## Ignores that are elevated to errors:
39+
# - type-as-html # not yet tested
40+
# - missing-constant-constructor # not yet tested
41+
# - missing-code-block-language # not yet tested

dev/bots/docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ function generate_docs() {
111111
# Install and activate dartdoc.
112112
# When updating to a new dartdoc version, please also update
113113
# `dartdoc_options.yaml` to include newly introduced error and warning types.
114-
"$DART" pub global activate dartdoc 6.3.0
114+
"$DART" pub global activate dartdoc 7.0.1
115115

116116
# Install and activate the snippets tool, which resides in the
117117
# assets-for-api-docs repo:

0 commit comments

Comments
 (0)