mirror of
https://github.com/flutter/flutter
synced 2024-08-23 18:11:03 +00:00
2c976b48d4
Adds this Dartdoc lint to the flutter repository, in replacement of the warning it used to have. Lint Proposal: https://github.com/dart-lang/linter/issues/4904 ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [X] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [X] I signed the [CLA]. - [X] I listed at least one issue that this PR fixes in the description above. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] I added new tests to check the change I am making, or this PR is [test-exempt]. - [X] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [Features we expect every widget to implement]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [Data Driven Fixes]: https://github.com/flutter/flutter/wiki/Data-driven-Fixes
43 lines
1.9 KiB
YAML
43 lines
1.9 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-example-file
|
|
- missing-from-search-index
|
|
- no-canonical-found
|
|
- no-documentable-libraries
|
|
- no-library-level-docs
|
|
- orphaned-file
|
|
- reexported-private-api-across-packages
|
|
- unknown-file
|
|
- unknown-html-fragment
|
|
- unknown-macro
|
|
- unresolved-doc-reference
|
|
## Ignores that are elevated to errors:
|
|
# - type-as-html # broken, https://github.com/dart-lang/dartdoc/issues/3545
|
|
- missing-constant-constructor
|