Skip to content

Commit 4d3f645

Browse files
authored
docs: exclude package-private members from API reference (#492)
Closes #484 ## How to test 1. Build the docs. 2. Open http://127.0.0.1:5500/api/Client/ 3. Check there are no (package) members.
2 parents 1df6525 + d951d0d commit 4d3f645

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

js-doc-config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@ module.exports = {
44
plugins: ['plugins/markdown'],
55
opts: {
66
destination: "./public/docs",
7+
// Exclude @package members from the public API documentation.
8+
// JSDoc renders all access levels except @private by default, so we
9+
// explicitly list the levels to render and leave "package" out.
10+
access: ["public", "protected", "undefined"],
711
}
812
}

0 commit comments

Comments
 (0)