diff --git a/plugins/sourcetag.js b/plugins/sourcetag.js index a92969d8..23854269 100644 --- a/plugins/sourcetag.js +++ b/plugins/sourcetag.js @@ -11,6 +11,11 @@ exports.handlers = { Support @source tag. Expected value like: { "filename": "myfile.js", "lineno": 123 } Modifies the corresponding meta values on the given doclet. + + WARNING: If you are using a JSDoc template that generates pretty-printed source files, + such as JSDoc's default template, this plugin can cause JSDoc to crash. To fix this issue, + update your template settings to disable pretty-printed source files. + @source { "filename": "sourcetag.js", "lineno": 13 } */ newDoclet: function(e) {