mirror of
https://github.com/dart-lang/sdk
synced 2024-07-05 17:30:16 +00:00
Update dartdoc to 1.0.0 and lock down dartdoc warnings.
Borrowed the list of warnings directly from Flutter. Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v1.0.0 Change-Id: Ic93229218a470c9ef469b89982dc2a3510d502da Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/205340 Reviewed-by: Devon Carew <devoncarew@google.com> Commit-Queue: Janice Collins <jcollins@google.com>
This commit is contained in:
parent
fc7aa585ea
commit
1426aff54e
2
DEPS
2
DEPS
|
@ -105,7 +105,7 @@ vars = {
|
|||
# For more details, see https://github.com/dart-lang/sdk/issues/30164
|
||||
"dart_style_rev": "f17c23e0eea9a870601c19d904e2a9c1a7c81470",
|
||||
|
||||
"dartdoc_rev" : "b733d4952dbd25374d55e28476a5f44bd60ed63f",
|
||||
"dartdoc_rev" : "b86cddcedf0737763d2e337c7474ad18d973fd4a",
|
||||
"devtools_rev" : "64cffbed6366329ad05e44d48fa2298367643bb6",
|
||||
"jsshell_tag": "version:88.0",
|
||||
"ffi_rev": "4dd32429880a57b64edaf54c9d5af8a9fa9a4ffb",
|
||||
|
|
|
@ -3481,13 +3481,9 @@
|
|||
"name": "validate SDK API docs",
|
||||
"script": "out/ReleaseX64/dart-sdk/bin/dartdoc",
|
||||
"arguments": [
|
||||
"--exclude",
|
||||
"dart:ffi,dart:html,dart:web_sql,dart:web_audio,dart:svg,dart:indexed_db",
|
||||
"--sdk-docs",
|
||||
"--no-generate-docs"
|
||||
],
|
||||
"comments1": "TODO(devoncarew): add --errors=unresolved-doc-reference above to fail on unresolved doc references",
|
||||
"comments2": "ambiguous-doc-reference, ambiguous-reexport, broken-link, deprecated, no-library-level-docs, unknown-directive, unknown-macro"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "validate SDK API data-driven fixes",
|
||||
|
|
|
@ -30,6 +30,31 @@ def Main(argv):
|
|||
linkToSource:
|
||||
root: '.'
|
||||
uriTemplate: 'https://github.com/dart-lang/sdk/blob/%s/sdk/%%f%%#L%%l%%'
|
||||
errors:
|
||||
# Default errors of dartdoc:
|
||||
- duplicate-file
|
||||
- invalid-parameter
|
||||
- no-defining-library-found
|
||||
- tool-error
|
||||
- unresolved-export
|
||||
# Warnings that are elevated to errors:
|
||||
- ambiguous-doc-reference
|
||||
- ambiguous-reexport
|
||||
- broken-link
|
||||
- category-order-gives-missing-package-name
|
||||
- deprecated
|
||||
- ignored-canonical-for
|
||||
- missing-from-search-index
|
||||
- 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
|
||||
''' % revision
|
||||
with open(args.output, 'w') as f:
|
||||
f.write(output)
|
||||
|
|
Loading…
Reference in New Issue
Block a user