schlechtenburg/packages/docgen/support/generate-function-md.mjs

20 lines
450 B
JavaScript
Raw Normal View History

2022-03-22 22:02:56 +00:00
import generateLibName from './generate-lib-name.mjs';
import generateTypeMd from './generate-type-md.mjs';
const generateParameterMd = (params) => params && params.length ? `
- **Parameters**
${params.map(param => `
- **${param.name}** \`${generateTypeMd(param.type)}\`
${param.comment?.shortText}
`)}
` : '';
export default (docs) => `
${generateLibName(docs)}
${docs.comment?.shortText || ''}
${generateParameterMd(docs.parameters)}
`;