add a warning about potential crashes (#554)

This commit is contained in:
Jeff Williams 2014-02-01 19:36:34 -08:00
parent 7b297d063a
commit c96a1215bd

View File

@ -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) {