File tree Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Original file line number Diff line number Diff line change @@ -118,7 +118,8 @@ Unrecognized options will be ignored. Supported options:
118118
119119 * **categories**: More details for each category/topic. For topics you'd like to document, specify
120120 the markdown file with ` markdown:` to use for the category page. Optionally, rename the
121- category from the source code into a display name with 'name:'.
121+ category from the source code into a display name with 'name:'. If there is no matching category
122+ defined in dartdoc_options.yaml, those declared categories in the source code will be invisible.
122123 * **categoryOrder**: Specify the order of topics for display in the sidebar and
123124 the package page.
124125 * **exclude**: Specify a list of library names to avoid generating docs for,
@@ -157,8 +158,8 @@ as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.
157158You can tag libraries or top level classes, functions, and variables in their documentation with
158159the string `{@category YourCategory}`. For libraries, that will cause the library to appear in a
159160category when showing the sidebar on the Package and Library pages. For other types of objects,
160- the `{@category}` will be shown with a link to the category page if specified in
161- dartdoc_options.yaml, as above.
161+ the `{@category}` will be shown with a link to the category page **but only if specified in
162+ dartdoc_options.yaml** , as above.
162163
163164` ` ` dart
164165/// Here is my library.
You can’t perform that action at this time.
0 commit comments