Skip to content

Commit bd21fdb

Browse files
authored
Clarify exclude/include behavior in README (#2193)
* Clarify exclude/include behavior in README * Grammar adjustment * Actually fix it.
1 parent 1a3f9c2 commit bd21fdb

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,23 @@ dartdoc:
120120
- tool-error
121121
```
122122
123+
#### dartdoc_options.yaml fields
124+
125+
In general, **paths are relative** to the directory of the `dartdoc_options.yaml` file in which the option
126+
is defined, and should be specified as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.
123127
Unrecognized options will be ignored. Supported options:
124128

125129
* **categories**: More details for each category/topic. For topics you'd like to document, specify
126130
the markdown file with `markdown:` to use for the category page. Optionally, rename the
127-
category from the source code into a display name with 'name:'. If there is no matching category
131+
category from the source code into a display name with `name:`. If there is no matching category
128132
defined in dartdoc_options.yaml, those declared categories in the source code will be invisible.
129133
* **categoryOrder**: Specify the order of topics for display in the sidebar and
130134
the package page.
131135
* **examplePathPrefix**: Specify the location of the example directory for resolving `@example`
132136
directives.
133137
* **exclude**: Specify a list of library names to avoid generating docs for,
134-
overriding any specified in include.
138+
overriding any specified in include. All libraries listed must be local to this package, unlike
139+
the command line `--exclude`.
135140
* **errors**: Specify warnings to be treated as errors. See the lists of valid warnings in the command
136141
line help for `--errors`, `--warnings`, and `--ignore`.
137142
* **favicon**: A path to a favicon for the generated docs.
@@ -140,21 +145,23 @@ Unrecognized options will be ignored. Supported options:
140145
* **header**: A list of paths to header files containing HTML text.
141146
* **ignore**: Specify warnings to be completely ignored. See the lists of valid warnings in the command
142147
line help for `--errors`, `--warnings`, and `--ignore`.
143-
* **include**: Specify a list of library names to generate docs for, ignoring all others.
148+
* **include**: Specify a list of library names to generate docs for, ignoring all others. All libraries
149+
listed must be local to this package (unlike the command line `--include`).
144150
* **includeExternal**: Specify a list of library filenames to add to the list of documented libraries.
145151
* **linkTo**: For other packages depending on this one, if this map is defined those packages
146152
will use the settings here to control how hyperlinks to the package are generated.
147-
This will override the default for packages hosted on pub.dev.
153+
This will override the default for packages hosted on [pub.dev](https://pub.dev) and
154+
[api.flutter.dev](https://api.flutter.dev).
148155
* **url**: A string indicating the base URL for documentation of this package. Ordinarily
149-
you do not need to set this in the package: consider --link-to-hosted and
150-
--link-to-sdks instead of this option if you need to build your own website with
156+
you do not need to set this in the package: consider `--link-to-hosted` and
157+
`--link-to-sdks` instead of this option if you need to build your own website with
151158
dartdoc.
152159

153160
The following strings will be substituted in to complete the URL:
154161
* `%b%`: The branch as indicated by text in the version. 2.0.0-dev.3 is branch "dev".
155162
No branch is considered to be "stable".
156-
* `%n%`: The name of this package, as defined in pubspec.yaml.
157-
* `%v%`: The version of this package as defined in pubspec.yaml.
163+
* `%n%`: The name of this package, as defined in `pubspec.yaml`.
164+
* `%v%`: The version of this package as defined in `pubspec.yaml`.
158165
* **linkToSource**: Generate links to a source code repository based on given templates and
159166
revision information.
160167
* **excludes**: A list of directories to exclude from processing source links.
@@ -171,9 +178,6 @@ Unrecognized options will be ignored. Supported options:
171178
* **warnings**: Specify otherwise ignored or set-to-error warnings to simply warn. See the lists
172179
of valid warnings in the command line help for `--errors`, `--warnings`, and `--ignore`.
173180

174-
In general, paths are relative to the directory the dartdoc_options.yaml the option is defined in
175-
and should be specified as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.
176-
177181
Unsupported and experimental options:
178182

179183
* **ambiguousReexportScorerMinConfidence**: The ambiguous reexport scorer will emit a warning if

0 commit comments

Comments
 (0)