dartdoc_options.yaml 852 Bytes
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."