mirror of
https://github.com/flutter/flutter
synced 2024-10-30 09:22:49 +00:00
39 lines
1.6 KiB
YAML
39 lines
1.6 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 have a snapshot built.
|
|
# The dev/tools/dartdoc.dart script does this automatically.
|
|
tools:
|
|
snippet:
|
|
command: ["dev/snippets/lib/main.dart", "--type=snippet"]
|
|
description: "Creates sample code documentation output from embedded documentation samples."
|
|
sample:
|
|
command: ["dev/snippets/lib/main.dart", "--type=sample"]
|
|
description: "Creates full application sample code documentation output from embedded documentation samples."
|
|
dartpad:
|
|
command: ["dev/snippets/lib/main.dart", "--type=sample", "--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
|
|
- 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
|