docs-site/api-doc-documented-files
Which source files the API reference documents, shared by the source walk and by the cross-site linker, so a link to another package’s site never names a page that site’s generator skipped.
Functions
Section titled “Functions”| Function | Description |
|---|---|
| isDocumentedDirectoryName | Checks whether a directory’s subtree is documented. |
| isDocumentedFileName | Checks whether a source file is documented, judged by its name alone. Excludes: *.test.ts (incl. *.browser.test.ts / *.integration.test.ts), *.d.ts, index.ts, __merged.ts, setup.ts and *-setup.ts. |
| isDocumentedModulePath | Checks whether a module, given by its path relative to the source folder, has documentation pages. |