renderFunctionPage
Renders a function’s signature, parameters, return value and examples.
Import:
import { renderFunctionPage } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-page-generation';Signature:
function renderFunctionPage(lines: string[], info: TypeInfo, allTypes: Map<string, TypeInfo>): voidParameters:
| Parameter | Type | Description |
|---|---|---|
lines |
string[] | The page lines to append to. |
info |
TypeInfo | The documented type. |
allTypes |
Map<string, TypeInfo> | Every documented type, keyed by $\{namespace\}#$\{name\}. |
Returns: void