Usage no npm install needed!

<script type="module">
  import doxy from 'https://cdn.skypack.dev/doxy';
</script>

README

doxy

Extracts single line // and multiline /* */ comments from a string or file. Has some added smarts for normalising indentation and aesthetic prefixing.

See the test fixture for the currently supported comment styles.

example

var doxy = require('./lib/doxy');
console.log(doxy.parse(string));

methods

var doxy = require('./lib/doxy')

doxy.parse(string);

Returns an array of comments contained in the string.

doxy.fromFile(pathToFile);

Returns a promise that resolves to the result of doxy.parse(fileContents).

install

With npm do:

npm install doxy

license

MIT