flutter_baidu_mapapi_map_maintained/dartdoc_options.yaml at main · wmuj/flutter_baidu_mapapi_map_maintained · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# This file is used by dartdoc when generating API documentation for Flutter.
dartdoc:
  include: ['flutter_baidu_mapapi_map']

  # linkToSource:
  #   root: '.'
  #   uriTemplate:
  showUndocumentedCategories: true
  ignore:
    - ambiguous-doc-reference
    - broken-link
    - unknown-file
  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
  warnings:
    - tool-error
  # 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=application']
  #     description: 'Creates application sample code documentation output from embedded documentation samples.'
  #   sample:
  #     command: ['dev/snippets/lib/main.dart', '--type=sample']
  #     description: 'Creates sample code documentation output from embedded documentation samples.'