dartdoc_options.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:
    - tool-error  # enabled by default
    - duplicate-file  # enabled by default
    - invalid-parameter  # enabled by default
    - unresolved-export  # enabled by default
    - unknown-macro  # a {@macro foo} reference cannot be resolved
    - invalid-parameter  # an invalid parameter is passed to a {@foo x y} directive