[API] Simplify JSDoc build

...since extraneous documentation no longer needs to be
worked-around.
This commit is contained in:
Victor Woeltjen 2016-09-30 12:27:39 -07:00
parent 04b8326900
commit 0012ca48c1
5 changed files with 3 additions and 31 deletions

View File

@ -1,13 +0,0 @@
module.exports = {
handlers: {
processingComplete: function (e) {
e.doclets.forEach(function (doclet) {
var memberof = doclet.memberof || "";
var longname = doclet.longname || "";
doclet.ignore = longname !== 'module:openmct' &&
memberof.indexOf('module:openmct') !== 0;
});
}
}
};

View File

@ -7,7 +7,6 @@
"excludePattern": ".+\\Spec\\.js$|lib/.+" "excludePattern": ".+\\Spec\\.js$|lib/.+"
}, },
"plugins": [ "plugins": [
"plugins/markdown", "plugins/markdown"
"build/jsdoc/plugins/mct-only"
] ]
} }

View File

@ -50,7 +50,7 @@
"test": "karma start --single-run", "test": "karma start --single-run",
"jshint": "jshint platform example", "jshint": "jshint platform example",
"watch": "karma start", "watch": "karma start",
"jsdoc": "jsdoc -c jsdoc.json -R API.md -r -d target/docs/api", "jsdoc": "jsdoc -c jsdoc.json -R API.md -r -d dist/docs/api",
"otherdoc": "node docs/gendocs.js --in docs/src --out target/docs --suppress-toc 'docs/src/index.md|docs/src/process/index.md'", "otherdoc": "node docs/gendocs.js --in docs/src --out target/docs --suppress-toc 'docs/src/index.md|docs/src/process/index.md'",
"docs": "npm run jsdoc ; npm run otherdoc", "docs": "npm run jsdoc ; npm run otherdoc",
"prepublish": "node ./node_modules/bower/bin/bower install && node ./node_modules/gulp/bin/gulp.js install" "prepublish": "node ./node_modules/bower/bin/bower install && node ./node_modules/gulp/bin/gulp.js install"

View File

@ -1,15 +0,0 @@
define([], function () {
// Adapts old-timey actions to the new-fangled way.
function AdaptedActionProvider(legacyActionService) {
this.legacyActionService = legacyActionService;
}
AdaptedActionProvider.prototype.get = function (context) {
var legacyContext = {};
legacyContext.domainObject =
};
return AdaptedActionProvider;
});

View File

@ -26,6 +26,7 @@ define(['zepto'], function ($) {
* @property {*} item * @property {*} item
* @property {HTMLElement} element * @property {HTMLElement} element
* @property {Context} parent the containing context (may be undefined) * @property {Context} parent the containing context (may be undefined)
* @memberof module:openmct
*/ */