@@ -103,13 +103,29 @@ generates docs.
103103``` yaml
104104dartdoc :
105105 categoryOrder : ["First Category", "Second Category"]
106-
107106` ` `
108- For now, there's only one option:
107+
108+ Unrecognized options will be ignored. For now, there's only one supported option:
109109
110110 * **categoryOrder**: Specify the order of categories, below, for display in the sidebar and
111111 the package page.
112-
112+
113+ The following are experimental options whose semantics are in flux and may be buggy. If you
114+ use one, please keep a close eye on the changing semantics. In general, paths are relative
115+ to the directory the dartdoc_options.yaml the option is defined in and should be specified
116+ as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.
117+
118+ * **ambiguousReexportScorerMinConfidence**: The ambiguous reexport scorer will emit a warning if
119+ it is not at least this confident. Default: 0.1
120+ * **examplePathPrefix**: Specify the prefix for the example paths, defaulting to the project root.
121+ * **exclude**: Specify a list of library names to avoid generating docs for, ignoring all others.
122+ * **favicon**: A path to a favicon for the generated docs.
123+ * **footer**: A list of paths to footer files containing HTML text.
124+ * **footerText**: A list of paths to text files for optional text next to the package name and version
125+ * **header**: A list of paths to header files containing HTML text.
126+ * **include**: Specify a list of library names to generate docs for, ignoring all others.
127+ * **includeExternal**: Specify a list of library filenames to add to the list of documented libraries.
128+
113129### Categories
114130
115131You can tag libraries in their documentation with the string ` {@category YourCategory}`, and
0 commit comments