forked from jsdoc/jsdoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add plugin that removes everything except JSDoc comments from source …
…files (jsdoc#304)
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
/** | ||
* @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 <[email protected]> | ||
*/ | ||
|
||
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'); | ||
console.log('source: ' + e.source); | ||
} | ||
}; |