ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-18 07:08:12 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[JSDoc] Add annotations

Browse Source 
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
platform/core/src/capabilities/CompositionCapability.js
View File

@ -37,6 +37,7 @@ define(
* require consulting the object service (e.g. to trigger a database
* query to retrieve the nested object models.)
*
* @memberof platform/core
* @constructor
*/
function CompositionCapability($injector, domainObject) {
@ -94,6 +95,7 @@ define(
* Request the composition of this object.
* @returns {Promise.<DomainObject[]>} a list of all domain
* objects which compose this domain object.
* @memberof platform/core.CompositionCapability#
*/
invoke: promiseComposition
};
@ -112,4 +114,4 @@ define(
return CompositionCapability;
}
);
);

6
platform/core/src/capabilities/ContextCapability.js
View File

@ -36,6 +36,7 @@ define(
* those whose `composition` capability was used to access this
* object.)
*
* @memberof platform/core
* @constructor
*/
function ContextCapability(parentObject, domainObject) {
@ -50,6 +51,7 @@ define(
*
* @returns {DomainObject} the immediate parent of this
* domain object.
* @memberof platform/core.ContextCapability#
*/
getParent: function () {
return parentObject;
@ -72,6 +74,7 @@ define(
* @returns {DomainObject[]} the full composition ancestry
* of the domain object which exposed this
* capability.
* @memberof platform/core.ContextCapability#
*/
getPath: function () {
var parentPath = [],
@ -95,6 +98,7 @@ define(
*
* @returns {DomainObject} the deepest ancestor of the domain
* object which exposed this capability.
* @memberof platform/core.ContextCapability#
*/
getRoot: function () {
var parentContext = parentObject &&
@ -109,4 +113,4 @@ define(
return ContextCapability;
}
);
);

3
platform/core/src/capabilities/ContextualDomainObject.js
View File

@ -42,6 +42,7 @@ define(
* @param {DomainObject} parentObject the domain object from which
* the wrapped object was retrieved
*
* @memberof platform/core
* @constructor
*/
function ContextualDomainObject(domainObject, parentObject) {
@ -63,4 +64,4 @@ define(
return ContextualDomainObject;
}
);
);

3
platform/core/src/capabilities/CoreCapabilityProvider.js
View File

@ -37,6 +37,7 @@ define(
* of constructor functions for capabilities, as
* exposed by extensions defined at the bundle level.
*
* @memberof platform/core
* @constructor
*/
function CoreCapabilityProvider(capabilities, $log) {
@ -84,6 +85,7 @@ define(
* @returns {Object.<string,function|Capability>} all
* capabilities known to be valid for this model, as
* key-value pairs
* @memberof platform/core.CoreCapabilityProvider#
*/
getCapabilities: getCapabilities
};
@ -92,3 +94,4 @@ define(
return CoreCapabilityProvider;
}
);

5
platform/core/src/capabilities/DelegationCapability.js
View File

@ -46,6 +46,7 @@ define(
* capabilities to be delegated.
*
* @param domainObject
* @memberof platform/core
* @constructor
*/
function DelegationCapability($q, domainObject) {
@ -96,6 +97,7 @@ define(
* @param {string} the name of the delegated capability
* @returns {DomainObject[]} the domain objects to which
* responsibility for this capability is delegated.
* @memberof platform/core.DelegationCapability#
*/
invoke: getDelegates,
/**
@ -105,6 +107,7 @@ define(
* @param {string} the name of the delegated capability
* @returns {DomainObject[]} the domain objects to which
* responsibility for this capability is delegated.
* @memberof platform/core.DelegationCapability#
*/
getDelegates: getDelegates,
doesDelegateCapability: doesDelegate
@ -115,4 +118,4 @@ define(
return DelegationCapability;
}
);
);

4
platform/core/src/capabilities/MetadataCapability.js
View File

@ -11,6 +11,8 @@ define(
* @property {string} name the human-readable name of this property
* @property {string} value the human-readable value of this property,
* for this specific domain object
* @constructor
* @memberof platform/core
*/
var TIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
@ -82,6 +84,7 @@ define(
/**
* Get metadata about this object.
* @returns {MetadataProperty[]} metadata about this object
* @memberof platform/core.MetadataCapability#
*/
invoke: getMetadata
};
@ -90,3 +93,4 @@ define(
return MetadataCapability;
}
);

5
platform/core/src/capabilities/MutationCapability.js
View File

@ -71,6 +71,7 @@ define(
*
* @param {DomainObject} domainObject the domain object
* which will expose this capability
* @memberof platform/core
* @constructor
*/
function MutationCapability(topic, now, domainObject) {
@ -118,6 +119,7 @@ define(
return {
/**
* Alias of `mutate`, used to support useCapability.
* @memberof platform/core.MutationCapability#
*/
invoke: mutate,
/**
@ -146,6 +148,7 @@ define(
* used)
* @returns {Promise.<boolean>} a promise for the result
* of the mutation; true if changes were made.
* @memberof platform/core.MutationCapability#
*/
mutate: mutate,
/**
@ -155,6 +158,7 @@ define(
* invoke the function returned by this method.
* @param {Function} listener function to call on mutation
* @returns {Function} a function to stop listening
* @memberof platform/core.MutationCapability#
*/
listen: listen
};
@ -163,3 +167,4 @@ define(
return MutationCapability;
}
);

6
platform/core/src/capabilities/PersistenceCapability.js
View File

@ -40,6 +40,7 @@ define(
* @param {DomainObject} the domain object which shall expose
* this capability
*
* @memberof platform/core
* @constructor
*/
function PersistenceCapability(persistenceService, SPACE, domainObject) {
@ -80,6 +81,7 @@ define(
* @returns {Promise} a promise which will be resolved
* if persistence is successful, and rejected
* if not.
* @memberof platform/core.PersistenceCapability#
*/
persist: function () {
updatePersistenceTimestamp();
@ -94,6 +96,7 @@ define(
* persistence.
* @returns {Promise} a promise which will be resolved
* when the update is complete
* @memberof platform/core.PersistenceCapability#
*/
refresh: function () {
var model = domainObject.getModel();
@ -114,6 +117,7 @@ define(
*
* @returns {string} the name of the space which should
* be used to persist this object
* @memberof platform/core.PersistenceCapability#
*/
getSpace: function () {
return SPACE;
@ -123,4 +127,4 @@ define(
return PersistenceCapability;
}
);
);

5
platform/core/src/capabilities/RelationshipCapability.js
View File

@ -38,6 +38,7 @@ define(
* which are not intended to appear in the tree, but are instead
* intended only for special, limited usage.
*
* @memberof platform/core
* @constructor
*/
function RelationshipCapability($injector, domainObject) {
@ -109,6 +110,7 @@ define(
* List all types of relationships exposed by this
* object.
* @returns {string[]} a list of all relationship types
* @memberof platform/core.RelationshipCapability#
*/
listRelationships: listRelationships,
/**
@ -118,6 +120,7 @@ define(
* @param {string} key the type of relationship
* @returns {Promise.<DomainObject[]>} a promise for related
* domain objects
* @memberof platform/core.RelationshipCapability#
*/
getRelatedObjects: promiseRelationships
};
@ -136,4 +139,4 @@ define(
return RelationshipCapability;
}
);
);