Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-10 23:03:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change JSDoc plugin to use "/*@jsdoc" tags instead of "/**jsdoc"

Browse source 
So as not to clash with Doxygen.
This commit is contained in:
David Rowe 2021-05-12 10:53:43 +12:00
parent 3020123459
commit bd812e58aa
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
tools/jsdoc/plugins/hifi.js
View file

@ -83,13 +83,13 @@ exports.handlers = {
// load entire file into a string // load entire file into a string
var data = fs.readFileSync(path, "utf8"); var data = fs.readFileSync(path, "utf8");
// this regex searches for blocks starting with /**jsdoc and end with */ // this regex searches for blocks starting with /*@jsdoc and end with */
var reg = /(\/\*\*jsdoc(.|[\r\n])*?\*\/)/gm; var reg = /(\/\*@jsdoc(.|[\r\n])*?\*\/)/gm;
var matches = data.match(reg); var matches = data.match(reg);
if (matches) { if (matches) {
// add to source, but strip off c-comment asterisks // add to source, but strip off c-comment asterisks
e.source += matches.map(function (s) { e.source += matches.map(function (s) {
return s.replace('/**jsdoc', '/**'); return s.replace('/*@jsdoc', '/**');
}).join('\n'); }).join('\n');
} }
} }