[API] Ignore internal API after processing

This commit is contained in:
Victor Woeltjen 2016-09-01 15:13:52 -07:00
parent f27c41014d
commit e37510dbab
4 changed files with 13 additions and 13 deletions

View File

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

View File

@ -11,7 +11,7 @@ define(function () {
/**
*
* @param {TypeDefinition} definition
* @constructor
* @class Type
*/
function Type(definition) {
this.definition = definition;

View File

@ -4,8 +4,7 @@ define([], function () {
* A View is used to provide displayable content, and to react to
* associated life cycle events.
*
* @constructor
* @memberof module:openmct
* @class
*/
function View() {

View File

@ -1,4 +1,4 @@
define(['./MCT'], function (MCT) {
define(['./MCT', './api/Type'], function (MCT, Type) {
/**
* Open MCT is an extensible web application for building mission
* control user interfaces. This module is itself an instance of
@ -6,8 +6,11 @@ define(['./MCT'], function (MCT) {
* configuring and executing the application.
*
* @exports openmct
* @borrows Type as Type
*/
var openmct = new MCT();
openmct.Type = Type;
return openmct;
});