2018-10-23 20:50:24 +00:00
|
|
|
# This file is used by dartdoc when generating API documentation for Flutter.
|
|
|
|
dartdoc:
|
2021-08-12 02:48:29 +00:00
|
|
|
# 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.
|
2018-10-23 20:50:24 +00:00
|
|
|
tools:
|
|
|
|
snippet:
|
2024-05-03 06:09:03 +00:00
|
|
|
command: ["bin/cache/artifacts/snippets/snippets", "--output-directory=doc/snippets", "--type=snippet"]
|
2020-01-08 23:28:02 +00:00
|
|
|
description: "Creates sample code documentation output from embedded documentation samples."
|
2018-10-23 20:50:24 +00:00
|
|
|
sample:
|
2024-05-03 06:09:03 +00:00
|
|
|
command: ["bin/cache/artifacts/snippets/snippets", "--output-directory=doc/snippets", "--type=sample"]
|
2020-01-08 23:28:02 +00:00
|
|
|
description: "Creates full application sample code documentation output from embedded documentation samples."
|
2019-09-10 15:36:14 +00:00
|
|
|
dartpad:
|
2024-05-03 06:09:03 +00:00
|
|
|
command: ["bin/cache/artifacts/snippets/snippets", "--output-directory=doc/snippets", "--type=dartpad"]
|
2020-01-08 23:28:02 +00:00
|
|
|
description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad."
|
2020-07-23 15:29:46 +00:00
|
|
|
errors:
|
2023-10-20 22:13:28 +00:00
|
|
|
## Default errors of dartdoc:
|
2020-07-28 23:11:04 +00:00
|
|
|
- duplicate-file
|
|
|
|
- invalid-parameter
|
|
|
|
- tool-error
|
|
|
|
- unresolved-export
|
2023-10-20 22:13:28 +00:00
|
|
|
## Warnings that are elevated to errors:
|
2020-07-28 23:11:04 +00:00
|
|
|
- ambiguous-doc-reference
|
|
|
|
- ambiguous-reexport
|
2020-07-30 21:11:23 +00:00
|
|
|
- broken-link
|
|
|
|
- category-order-gives-missing-package-name
|
2020-09-22 19:57:13 +00:00
|
|
|
- deprecated
|
2020-07-28 23:11:04 +00:00
|
|
|
- ignored-canonical-for
|
2023-11-21 01:02:00 +00:00
|
|
|
- missing-example-file
|
2020-07-30 21:11:23 +00:00
|
|
|
- missing-from-search-index
|
2020-07-28 23:11:04 +00:00
|
|
|
- no-canonical-found
|
2020-10-07 15:47:05 +00:00
|
|
|
- no-documentable-libraries
|
2020-07-28 23:11:04 +00:00
|
|
|
- no-library-level-docs
|
2020-07-31 17:01:03 +00:00
|
|
|
- orphaned-file
|
2020-07-28 23:11:04 +00:00
|
|
|
- reexported-private-api-across-packages
|
|
|
|
- unknown-file
|
2023-11-21 01:02:00 +00:00
|
|
|
- unknown-html-fragment
|
2020-07-31 17:01:03 +00:00
|
|
|
- unknown-macro
|
2020-07-30 21:11:23 +00:00
|
|
|
- unresolved-doc-reference
|
2023-10-20 22:13:28 +00:00
|
|
|
## Ignores that are elevated to errors:
|
2023-10-23 22:59:59 +00:00
|
|
|
# - type-as-html # broken, https://github.com/dart-lang/dartdoc/issues/3545
|
|
|
|
- missing-constant-constructor
|