ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-18 20:57:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[API] Give up on borrows-style documentation

Browse Source
This commit is contained in:
Victor Woeltjen 2016-09-02 14:58:06 -07:00
parent b5f62541ce
commit d592bd1035
3 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/MCT.js
View File

@ -22,6 +22,7 @@ define([
* The Open MCT application. This may be configured by installing plugins * The Open MCT application. This may be configured by installing plugins
* or registering extensions before the application is started. Foo? * or registering extensions before the application is started. Foo?
* @class MCT * @class MCT
* @memberof module:openmct
*/ */
function MCT() { function MCT() {
EventEmitter.call(this); EventEmitter.call(this);
@ -46,6 +47,7 @@ define([
/** /**
* Set path to where assets are hosted. This should be the path to main.js. * Set path to where assets are hosted. This should be the path to main.js.
* @memberof module:openmct.MCT
*/ */
MCT.prototype.setAssetPath = function (path) { MCT.prototype.setAssetPath = function (path) {
this.legacyExtension('constants', { this.legacyExtension('constants', {
@ -60,6 +62,7 @@ define([
* @param region the region identifier (see mct.regions) * @param region the region identifier (see mct.regions)
* @param {ViewDefinition} definition the definition for this view * @param {ViewDefinition} definition the definition for this view
* @method * @method
* @memberof module:openmct.MCT
*/ */
MCT.prototype.view = function (region, definition) { MCT.prototype.view = function (region, definition) {
var viewKey = region + uuid(); var viewKey = region + uuid();
@ -114,6 +117,7 @@ define([
* Register a new [type]{@link module:openmct.Type} of domain object. * Register a new [type]{@link module:openmct.Type} of domain object.
* @param {string} key a unique identifier for this type of object * @param {string} key a unique identifier for this type of object
* @param {module:openmct.Type} type the new type * @param {module:openmct.Type} type the new type
* @memberof module:openmct.MCT
*/ */
MCT.prototype.type = function (key, type) { MCT.prototype.type = function (key, type) {
var legacyDef = type.toLegacyDefinition(); var legacyDef = type.toLegacyDefinition();
@ -137,6 +141,7 @@ define([
* Start running Open MCT. This should be called only after any plugins * Start running Open MCT. This should be called only after any plugins
* have been installed. * have been installed.
* @fires module:openmct.MCT#start * @fires module:openmct.MCT#start
* @memberof module:openmct.MCT
*/ */
MCT.prototype.start = function () { MCT.prototype.start = function () {
this.legacyExtension('runs', { this.legacyExtension('runs', {
@ -157,6 +162,7 @@ define([
* *
* @param {Function} plugin a plugin install function which will be * @param {Function} plugin a plugin install function which will be
* invoked with the mct instance. * invoked with the mct instance.
* @memberof module:openmct.MCT
*/ */
MCT.prototype.install = function (plugin) { MCT.prototype.install = function (plugin) {
plugin(this); plugin(this);

3
src/api/Type.js
View File

@ -9,9 +9,12 @@ define(function () {
*/ */
/** /**
* A Type describes a kind of domain object that may appear or be
* created within Open MCT.
* *
* @param {TypeDefinition} definition * @param {TypeDefinition} definition
* @class Type * @class Type
* @memberof module:openmct
*/ */
function Type(definition) { function Type(definition) {
this.definition = definition; this.definition = definition;

2
src/openmct.js
View File

@ -6,8 +6,6 @@ define(['./MCT', './api/Type'], function (MCT, Type) {
* configuring and executing the application. * configuring and executing the application.
* *
* @exports openmct * @exports openmct
* @borrows Type as Type
* @borrows MCT as MCT
*/ */
var openmct = new MCT(); var openmct = new MCT();