Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

string-to-jsdoc-comment

gr2m151ISC1.0.0

Turns a string into a JSDoc comment

jsdoc

readme

string-to-jsdoc-comment

Turns a string into a JSDoc comment

Build Status Greenkeeper

const { stringToJsdocComment } = require('string-to-jsdoc-comment')

const comment = stringToJsdocComment('Here is some description.')

comment is now

/**
 * Here is some description.
 */

Credit

This method was extracted from @octokit/rest. The original method was implemented by @gimenete.

License

ICS