Skip to content

Commit 698dd76

Browse files
authored
Add docs.sort documentation for configuration
1 parent d8ff91a commit 698dd76

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

packages/webdoc-cli/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,21 @@ webdoc determines the list of source files as follows:
4545
2. Paths matching atleast one `source.includePattern` are kept (skipped if no include pattern is provided).
4646
3. Paths matching atleast one `source.excludePattern` are filtered out.
4747
4. All paths that equal or are inside a path in `source.exclude` are filtered out.
48+
49+
#### docs
50+
51+
The `docs` object has options to configure the generation of the document tree.
52+
53+
```json
54+
{
55+
"docs": {
56+
"sort": ["type", "scope", "access", "name"]
57+
}
58+
}
59+
```
60+
61+
* `docs.sort`: The characteristics of documented symbols which are used for sorting them, in order of decreasing priority. The valid values are:
62+
* `"type"`: Order by type as follows: namespaces, classes, enumerations, type definitions, properties, methods, events.
63+
* `"scope"`: Order by scope as follows: static, instance, inner.
64+
* `"access"`: Order by access as follows: public, protected, private.
65+
* `"name"`: Order alphabetically by the simple-name.

0 commit comments

Comments
 (0)