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