NgDoc

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

firstNodeWithComment

Generic types:T

Returns first node that has JSDoc comment, will return first node, if there are no comment nodes

Presentation

function firstNodeWithComment(nodes: T[]): T | undefined;

Returns

T | undefined

Parameters

NameTypeDescription
nodes
T[]
MIT © 2023 Aleksandr Skoropad