Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-23 13:13:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

jsdoc - namealias fix

Browse source 
Corrected the namealias jsdoc plugin to not include PIXI-from-YUI docs.

This is because they lack corresponding javascript code and need the
'name' property to remain intact.
This commit is contained in:
Paul 2014-12-01 17:09:19 -08:00
parent 152b26a668
commit cc8c2944fa
1 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
tasks/jsdoc-plugins/namealias.js
View file

@ -12,18 +12,31 @@
* to rewrite the @class [@constructor] to @alias @class which enables JSDoc to collect better data. * to rewrite the @class [@constructor] to @alias @class which enables JSDoc to collect better data.
*/ */
// Regular expression to match a line starting with what appears to be a doclet tag.
// This only works for solo single-line doclet tags. The line start is captured in $1,
// the doclet tag in $2 and everything else in $3.
var extract = /^(\s*(?:\/\*{2,}|\*{1,})\s*)(@\w+)\s*?([^\r\n]*)/mg;
exports.handlers = {}; exports.handlers = {};
exports.handlers.jsdocCommentFound = function (e) { exports.handlers.jsdocCommentFound = function (e) {
var raw = e.comment; var raw = e.comment;
var m = /^(\s*[*])\s*@class\b/m.exec(raw); var classdoc = /@class\b/.exec(raw);
if (m) var sourcefile = /@sourcefile\b/.exec(raw);
// PIXI docs generated from YUIDocs have @sourcefile (but no code) and need to be excluded
if (classdoc && !sourcefile)
{ {
// @class X -> @alias X / @class raw = raw.replace(extract, function (m, pre, doclet, extra) {
raw = raw.replace(/^(\s*[*])\s*@class[ \t]+(\S+).*?((?=[\r\n]+))/mg, "$1 @alias $2$3$1 @class"); if (doclet === '@class' && extra.trim()) {
// @constructor -> {removed} return pre + '@alias ' + extra.trim() + '\n' + pre + '@class';
raw = raw.replace(/^(\s*[*])\s*@constructor\b.*?(?=[\r\n]+)/mg, "$1"); } else if (doclet === '@constructor') {
return '';
} else {
return m;
}
});
e.comment = raw; e.comment = raw;
} }