dartdoc_options.yaml 1.79 KB
Newer Older
1 2
# This file is used by dartdoc when generating API documentation for Flutter.
dartdoc:
3 4 5
  # 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.
6 7
  tools:
    snippet:
8
      command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=snippet"]
9
      description: "Creates sample code documentation output from embedded documentation samples."
10
    sample:
11
      command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=sample"]
12
      description: "Creates full application sample code documentation output from embedded documentation samples."
13
    dartpad:
14
      command: ["bin/cache/dart-sdk/bin/dart", "pub", "global", "run", "snippets", "--output-directory=doc/snippets", "--type=dartpad"]
15
      description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad."
16
  errors:
17
    # Default errors of dartdoc:
18 19
    - duplicate-file
    - invalid-parameter
20
    - no-defining-library-found
21 22
    - tool-error
    - unresolved-export
23
    # Warnings that are elevated to errors:
24 25
    - ambiguous-doc-reference
    - ambiguous-reexport
26 27
    - broken-link
    - category-order-gives-missing-package-name
28
    - deprecated
29
    - ignored-canonical-for
30
    - missing-from-search-index
31
    - no-canonical-found
32
    - no-documentable-libraries
33
    - no-library-level-docs
34
    - not-implemented
35
    - orphaned-file
36
    - reexported-private-api-across-packages
37
    # - unknown-directive  # Disabled due to https://github.com/dart-lang/dartdoc/issues/2353
38
    - unknown-file
39
    - unknown-macro
40
    - unresolved-doc-reference