mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
16 lines
533 B
JavaScript
16 lines
533 B
JavaScript
/**
|
|
* @overview Remove everything in a file except JSDoc-style comments. By enabling this plugin, you
|
|
* can document source files that are not valid JavaScript (including source files for other
|
|
* languages).
|
|
* @module plugins/commentsOnly
|
|
* @author Jeff Williams <jeffrey.l.williams@gmail.com>
|
|
*/
|
|
|
|
exports.handlers = {
|
|
beforeParse: function(e) {
|
|
// a JSDoc comment looks like: /**[one or more chars]*/
|
|
var comments = e.source.match(/\/\*\*[\s\S]+?\*\//g);
|
|
e.source = comments.join('\n\n');
|
|
}
|
|
};
|