Created
February 16, 2021 17:30
-
-
Save fredgrott/166c26da473aad5fc77c700a8e0b4ea5 to your computer and use it in GitHub Desktop.
dartdoc options yaml file base
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This file is used by dartdoc when generating API documentation for Flutter. | |
dartdoc: | |
# Before you can run dartdoc, the snippets tool needs to have a snapshot built. | |
# The dev/tools/dartdoc.dart script does this automatically. | |
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 | |
favicon: doc_assets\favicon-32x32.png | |
header: doc_assets\header.html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment