2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-20 01:55:45 +00:00
phaser/tasks/pixidoc.js
Paul 66ab47ff09 PIXI-in-Docs: fixed line numbers
- Also added support for various additional meta-tags
- Minor code cleanup
2014-11-03 18:49:32 -08:00

60 lines
1.5 KiB
JavaScript

/**
* Generates the appropriate JSDoc from some (PIXI) YUIDoc.
* This could be turned into a more general pacakge.
*
* Requires: yuidocjs
*/
'use strict';
function generateYuiDoc (sourcePaths, grunt) {
var Y = require('yuidocjs');
var options = {
parseOnly: true,
quiet: true,
paths: sourcePaths
};
return (new Y.YUIDoc(options)).run();
}
module.exports = function (grunt) {
grunt.registerTask('pixidoc', 'Generates JSDoc from the PIXI YUIdocs', function () {
var sources = ['src/pixi'];
var output = 'docs/pixi-jsdoc.js';
var yui2jsdoc = require('./yuidoc-to-jsdoc/converter');
var fs = require('fs');
var path = require('path');
// Right now yuidocsjs requires an absolute path so it emits an
// absolute path in the jsdoc (or the JSDoc will error on missing files)
sources = sources.map(function (source) {
return path.resolve(source);
});
var data = generateYuiDoc(sources);
if (!data) {
grunt.fail.warn("PIXI YUIDoc not generated - nothing to do");
return;
}
// Fake in namespace (current limitation)
// A preamble/warning wrt the YUIDoc-to-JSDoc with proper link-outs could
// also be added here.
var header =
"/**\n" +
"* @namespace PIXI\n" +
"*/";
var comments = yui2jsdoc.convert(data);
comments.unshift(header);
fs.writeFileSync(output, comments.join("\n"));
});
};