c93e80a14a
Because we don't know if a new or modified file includes changes to the class hierarchy, we regenerate info for all sources any time any one has changed. An alternative would be to generate info first for the new or modified file and then (potentially) regenerate info for more source files in the class hierarchy, but this makes the generate-info.js task far more complicated.
60 lines
1.7 KiB
JavaScript
60 lines
1.7 KiB
JavaScript
/**
|
|
* @fileoverview Generates JSON output based on exportable symbols (those with
|
|
* an api tag) and boolean defines (with a define tag and a default value).
|
|
*/
|
|
var assert = require('assert');
|
|
var fs = require('fs');
|
|
var path = require('path');
|
|
|
|
|
|
/**
|
|
* Publish hook for the JSDoc template. Writes to JSON stdout.
|
|
* @param {function} data The root of the Taffy DB containing doclet records.
|
|
* @param {Object} opts Options.
|
|
*/
|
|
exports.publish = function(data, opts) {
|
|
var cwd = process.cwd();
|
|
|
|
// get all doclets with the "api" property or define (excluding enums,
|
|
// typedefs and events)
|
|
var docs = data(
|
|
[{define: {isObject: true}}, {api: {isString: true}}],
|
|
{isEnum: {'!is': true}},
|
|
{kind: {'!is': 'typedef'}},
|
|
{kind: {'!is': 'event'}}).get();
|
|
|
|
// get symbols data, filter out those that are members of private classes
|
|
var symbols = [];
|
|
var defines = [];
|
|
docs.filter(function(doc) {
|
|
var include = true;
|
|
var constructor = doc.memberof;
|
|
if (constructor && constructor.substr(-1) === '_') {
|
|
assert.strictEqual(doc.inherited, true,
|
|
'Unexpected export on private class: ' + doc.longname);
|
|
include = false;
|
|
}
|
|
return include;
|
|
}).forEach(function(doc) {
|
|
if (doc.define) {
|
|
defines.push({
|
|
name: doc.longname,
|
|
description: doc.description,
|
|
path: path.join(doc.meta.path, doc.meta.filename),
|
|
default: doc.define.default
|
|
});
|
|
} else {
|
|
symbols.push({
|
|
name: doc.longname,
|
|
kind: doc.kind,
|
|
description: doc.classdesc || doc.description,
|
|
path: path.join(doc.meta.path, doc.meta.filename)
|
|
});
|
|
}
|
|
});
|
|
|
|
process.stdout.write(
|
|
JSON.stringify({symbols: symbols, defines: defines}, null, 2));
|
|
|
|
};
|