blob: 8f731016893b5c740a568638398cb0a7b74829e7 [file] [log] [blame]
Greg Spencer65d3ddd2018-10-23 13:50:24 -07001# This file is used by dartdoc when generating API documentation for Flutter.
2dartdoc:
Greg Spencer10e4b042021-08-11 19:48:29 -07003 # 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 Spencer65d3ddd2018-10-23 13:50:24 -07006 tools:
7 snippet:
Greg Spencera7310dc2021-08-30 12:16:05 -07008 command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=snippet"]
Greg Spencerfabf4e32020-01-08 15:28:02 -08009 description: "Creates sample code documentation output from embedded documentation samples."
Greg Spencer65d3ddd2018-10-23 13:50:24 -070010 sample:
Greg Spencera7310dc2021-08-30 12:16:05 -070011 command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=sample"]
Greg Spencerfabf4e32020-01-08 15:28:02 -080012 description: "Creates full application sample code documentation output from embedded documentation samples."
Andrew Brogdon69197772019-09-10 08:36:14 -070013 dartpad:
Greg Spencera7310dc2021-08-30 12:16:05 -070014 command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"]
Greg Spencerfabf4e32020-01-08 15:28:02 -080015 description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad."
Michael Goderbauer4b4287b2020-07-23 08:29:46 -070016 errors:
Michael Goderbauer997a94f2023-10-20 15:13:28 -070017 ## Default errors of dartdoc:
Michael Goderbauerf4e10b42020-07-28 16:11:04 -070018 - duplicate-file
19 - invalid-parameter
20 - tool-error
21 - unresolved-export
Michael Goderbauer997a94f2023-10-20 15:13:28 -070022 ## Warnings that are elevated to errors:
Michael Goderbauerf4e10b42020-07-28 16:11:04 -070023 - ambiguous-doc-reference
24 - ambiguous-reexport
Michael Goderbauerf4e10b42020-07-28 16:11:04 -070025 - broken-link
Michael Goderbauer6ca8fda2020-07-30 14:11:23 -070026 - category-order-gives-missing-package-name
Michael Goderbauer923eb762020-09-22 12:57:13 -070027 - deprecated
Michael Goderbauer6ca8fda2020-07-30 14:11:23 -070028 - ignored-canonical-for
Michael Goderbauer24b99e52023-11-20 17:02:00 -080029 - missing-example-file
Michael Goderbauerf4e10b42020-07-28 16:11:04 -070030 - missing-from-search-index
Michael Goderbauer6ca8fda2020-07-30 14:11:23 -070031 - no-canonical-found
Janice Collinse9a9a612020-10-07 08:47:05 -070032 - no-documentable-libraries
Michael Goderbauer6ca8fda2020-07-30 14:11:23 -070033 - no-library-level-docs
Michael Goderbauer6ca8fda2020-07-30 14:11:23 -070034 - orphaned-file
Michael Goderbauer94f76d62020-07-31 10:01:03 -070035 - reexported-private-api-across-packages
36 - unknown-file
Michael Goderbauer24b99e52023-11-20 17:02:00 -080037 - unknown-html-fragment
Michael Goderbauer94f76d62020-07-31 10:01:03 -070038 - unknown-macro
39 - unresolved-doc-reference
Michael Goderbauer997a94f2023-10-20 15:13:28 -070040 ## Ignores that are elevated to errors:
Michael Goderbauer58b64782023-10-23 15:59:59 -070041 # - 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