Skip to content

Commit 9897f83

Browse files
committed
Update README
1 parent 530af4f commit 9897f83

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ authoring doc comments for Dart with `dartdoc`.
102102
Creating a file named dartdoc_options.yaml at the top of your package can change how Dartdoc
103103
generates docs.
104104

105-
An example:
105+
An example (not necessarily recommended settings):
106106

107107
```yaml
108108
dartdoc:
@@ -119,6 +119,12 @@ dartdoc:
119119
linkTo:
120120
url: "https://my.dartdocumentationsite.org/dev/%v%"
121121
showUndocumentedCategories: true
122+
ignore:
123+
- ambiguous-doc-reference
124+
errors:
125+
- unresolved-doc-reference
126+
warn:
127+
- tool-error
122128
```
123129
124130
Unrecognized options will be ignored. Supported options:
@@ -133,10 +139,14 @@ Unrecognized options will be ignored. Supported options:
133139
directives.
134140
* **exclude**: Specify a list of library names to avoid generating docs for,
135141
overriding any specified in include.
142+
* **errors**: Specify warnings to be treated as errors. See the lists of valid warnings in the command
143+
line help for `--errors`, `--warnings`, and `--ignore`.
136144
* **favicon**: A path to a favicon for the generated docs.
137145
* **footer**: A list of paths to footer files containing HTML text.
138146
* **footerText**: A list of paths to text files for optional text next to the package name and version
139147
* **header**: A list of paths to header files containing HTML text.
148+
* **ignore**: Specify warnings to be completely ignored. See the lists of valid warnings in the command
149+
line help for `--errors`, `--warnings`, and `--ignore`.
140150
* **include**: Specify a list of library names to generate docs for, ignoring all others.
141151
* **includeExternal**: Specify a list of library filenames to add to the list of documented libraries.
142152
* **linkTo**: For other packages depending on this one, if this map is defined those packages
@@ -152,6 +162,8 @@ Unrecognized options will be ignored. Supported options:
152162
No branch is considered to be "stable".
153163
* `%n%`: The name of this package, as defined in pubspec.yaml.
154164
* `%v%`: The version of this package as defined in pubspec.yaml.
165+
* **warnings**: Specify otherwise ignored or set-to-error warnings to simply warn. See the lists
166+
of valid warnings in the command line help for `--errors`, `--warnings`, and `--ignore`.
155167

156168
In general, paths are relative to the directory the dartdoc_options.yaml the option is defined in
157169
and should be specified as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.

0 commit comments

Comments
 (0)