(docs: WithSignatures, prefix: string, syntaxName: string = 'Syntax')
| 198 | } |
| 199 | |
| 200 | function withSignaturesToMarkdown(docs: WithSignatures, prefix: string, syntaxName: string = 'Syntax'): string { |
| 201 | return [ |
| 202 | `## ${docs.shortDescription}`, |
| 203 | docs.longDescription ? `**Description:** ${docs.longDescription}` : '', |
| 204 | '', |
| 205 | `**${syntaxName}:**`, |
| 206 | '```alphatex', |
| 207 | ...docs.signatures.map((s, i) => signatureToSyntax(prefix, s, i, docs.signatures.length > 1)), |
| 208 | '```', |
| 209 | '', |
| 210 | signatureParametersToMarkdownTable(docs.signatures) |
| 211 | ].join('\n'); |
| 212 | } |
| 213 | |
| 214 | function signatureParametersToMarkdownTable(signatures: SignatureDefinition[]): string { |
| 215 | if (signatures.length === 0 || (signatures.length === 1 && signatures[0].parameters.length === 0)) { |
no test coverage detected