NgDoc

What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
Auto generation Documenting declarations Rendering API NEW
Page Processors Page Skeleton Layout Search Themes UPDATED Icons
Performance Ignoring file lines
API References Develop
@ng-doc/builder / Function

getCategorySourceFile

Retrieves the source file for a given category.

Presentation

function getCategorySourceFile(sourceFile: SourceFile): SourceFile | undefined;

Returns

SourceFile | undefined -

{SourceFile | undefined} The source file for the category, or undefined if it could not be found.

Parameters

NameTypeDescription
sourceFile
SourceFile

The source file to retrieve the category from.

MIT © 2023 Aleksandr Skoropad