Skip to content

docs-site/api-doc-source-processing

Source discovery + extraction: walks src, filters to documentable entry files, and turns each file’s exported declarations into TypeInfo entries keyed by a qualified ${namespace}#${name}.

Function Description
collectFunctions Collect top-level exported functions.
collectPackageDeclarations Records where every symbol a source file imports is declared, so a type another documented package declares links to that package’s site.
collectVariables Collect top-level exported variable declarations (e.g. export const EMPTY = '').
computeCacheHash Compute a hash of every input that decides the generated pages: the generator’s own modules, the settings and the entry source files. An unchanged hash lets a run skip the generation.
computeNamespace Compute the namespace (POSIX path relative to src, no extension) for a source file.
findEntryFiles Recursively find all documentable *.ts entry files under src. Excludes: *.test.ts (incl. *.browser.test.ts / *.integration.test.ts), *.d.ts, index.ts, __merged.ts, setup.ts, *-setup.ts, and any subtree under a @types, styles, or test-helpers directory.
processSourceFile Collects a source file’s exported type aliases, enums, interfaces and classes.
registerGenericTypeParams Register all type parameter names so renderTypeWithLinks won’t hyperlink them. Skip names that are also known types — those should still be linkable.