Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 1 | # This file is used by dartdoc when generating API documentation for Flutter. |
| 2 | dartdoc: |
Greg Spencer | 10e4b04 | 2021-08-11 19:48:29 -0700 | [diff] [blame] | 3 | # Before you can run dartdoc, the snippets tool needs to be |
| 4 | # activated with "pub global activate snippets <version>" |
| 5 | # The dev/bots/docs.sh script does this automatically. |
Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 6 | tools: |
| 7 | snippet: |
Greg Spencer | a7310dc | 2021-08-30 12:16:05 -0700 | [diff] [blame] | 8 | command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=snippet"] |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 9 | description: "Creates sample code documentation output from embedded documentation samples." |
Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 10 | sample: |
Greg Spencer | a7310dc | 2021-08-30 12:16:05 -0700 | [diff] [blame] | 11 | command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=sample"] |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 12 | description: "Creates full application sample code documentation output from embedded documentation samples." |
Andrew Brogdon | 6919777 | 2019-09-10 08:36:14 -0700 | [diff] [blame] | 13 | dartpad: |
Greg Spencer | a7310dc | 2021-08-30 12:16:05 -0700 | [diff] [blame] | 14 | command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"] |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 15 | description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad." |
Michael Goderbauer | 4b4287b | 2020-07-23 08:29:46 -0700 | [diff] [blame] | 16 | errors: |
Michael Goderbauer | 997a94f | 2023-10-20 15:13:28 -0700 | [diff] [blame] | 17 | ## Default errors of dartdoc: |
Michael Goderbauer | f4e10b4 | 2020-07-28 16:11:04 -0700 | [diff] [blame] | 18 | - duplicate-file |
| 19 | - invalid-parameter |
| 20 | - tool-error |
| 21 | - unresolved-export |
Michael Goderbauer | 997a94f | 2023-10-20 15:13:28 -0700 | [diff] [blame] | 22 | ## Warnings that are elevated to errors: |
Michael Goderbauer | f4e10b4 | 2020-07-28 16:11:04 -0700 | [diff] [blame] | 23 | - ambiguous-doc-reference |
| 24 | - ambiguous-reexport |
Michael Goderbauer | f4e10b4 | 2020-07-28 16:11:04 -0700 | [diff] [blame] | 25 | - broken-link |
Michael Goderbauer | 6ca8fda | 2020-07-30 14:11:23 -0700 | [diff] [blame] | 26 | - category-order-gives-missing-package-name |
Michael Goderbauer | 923eb76 | 2020-09-22 12:57:13 -0700 | [diff] [blame] | 27 | - deprecated |
Michael Goderbauer | 6ca8fda | 2020-07-30 14:11:23 -0700 | [diff] [blame] | 28 | - ignored-canonical-for |
Michael Goderbauer | 24b99e5 | 2023-11-20 17:02:00 -0800 | [diff] [blame] | 29 | - missing-example-file |
Michael Goderbauer | f4e10b4 | 2020-07-28 16:11:04 -0700 | [diff] [blame] | 30 | - missing-from-search-index |
Michael Goderbauer | 6ca8fda | 2020-07-30 14:11:23 -0700 | [diff] [blame] | 31 | - no-canonical-found |
Janice Collins | e9a9a61 | 2020-10-07 08:47:05 -0700 | [diff] [blame] | 32 | - no-documentable-libraries |
Michael Goderbauer | 6ca8fda | 2020-07-30 14:11:23 -0700 | [diff] [blame] | 33 | - no-library-level-docs |
Michael Goderbauer | 6ca8fda | 2020-07-30 14:11:23 -0700 | [diff] [blame] | 34 | - orphaned-file |
Michael Goderbauer | 94f76d6 | 2020-07-31 10:01:03 -0700 | [diff] [blame] | 35 | - reexported-private-api-across-packages |
| 36 | - unknown-file |
Michael Goderbauer | 24b99e5 | 2023-11-20 17:02:00 -0800 | [diff] [blame] | 37 | - unknown-html-fragment |
Michael Goderbauer | 94f76d6 | 2020-07-31 10:01:03 -0700 | [diff] [blame] | 38 | - unknown-macro |
| 39 | - unresolved-doc-reference |
Michael Goderbauer | 997a94f | 2023-10-20 15:13:28 -0700 | [diff] [blame] | 40 | ## Ignores that are elevated to errors: |
Michael Goderbauer | 58b6478 | 2023-10-23 15:59:59 -0700 | [diff] [blame] | 41 | # - type-as-html # broken, https://github.com/dart-lang/dartdoc/issues/3545 |
| 42 | - missing-constant-constructor |
| 43 | # - missing-code-block-language # blocked on https://github.com/dart-lang/matcher/pull/230 |