Skip to main content

writeNode

Summary

Writes a single TSDoc node to the output

Signature

protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void;

Parameters

docNode

Type:DocNode The TSDoc node to write

context

Type:IMarkdownEmitterContext Emission context (writer, formatting state)

docNodeSiblings

Type:boolean Whether this node has siblings (used for formatting decisions)

Returns

Type:void Writes a single TSDoc node to the output

Remarks

This is the core dispatch method that handles all TSDoc node types: - PlainText - Regular text content - HtmlStartTag/HtmlEndTag - Raw HTML pass-through - CodeSpan - Inline code (backticks) - LinkTag - Links to code symbols or URLs - Paragraph - Text blocks with spacing - FencedCode - Code blocks with syntax highlighting - Section - Logical grouping of content - SoftBreak - Whitespace normalization - EscapedText - Pre-escaped text - ErrorText - Parser error recovery - InlineTag - Ignored (handled elsewhere) - BlockTag - Known tags skipped, unknown tags logged Subclasses can override this to customize handling for specific node types.