mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
997a94fd1f
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.
42 lines
1.8 KiB
YAML
42 lines
1.8 KiB
YAML
# This file is used by dartdoc when generating API documentation for Flutter.
|
|
dartdoc:
|
|
# Before you can run dartdoc, the snippets tool needs to be
|
|
# activated with "pub global activate snippets <version>"
|
|
# The dev/bots/docs.sh script does this automatically.
|
|
tools:
|
|
snippet:
|
|
command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=snippet"]
|
|
description: "Creates sample code documentation output from embedded documentation samples."
|
|
sample:
|
|
command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=sample"]
|
|
description: "Creates full application sample code documentation output from embedded documentation samples."
|
|
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."
|
|
errors:
|
|
## Default errors of dartdoc:
|
|
- duplicate-file
|
|
- invalid-parameter
|
|
- 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
|
|
- orphaned-file
|
|
- reexported-private-api-across-packages
|
|
- 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
|