ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-15 21:58:13 +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/models/CachingModelDecorator.js
View File

@ -30,6 +30,7 @@ define(
* The caching model decorator maintains a cache of loaded domain
* object models, and ensures that duplicate models for the same
* object are not provided.
* @memberof platform/core
* @constructor
*/
function CachingModelDecorator(modelService) {
@ -114,6 +115,7 @@ define(
* containing key-value pairs, where keys are
* ids and values are models
* @method
* @memberof platform/core.CachingModelDecorator#
*/
getModels: function (ids) {
var neededIds = ids.filter(notCached);
@ -133,4 +135,4 @@ define(
return CachingModelDecorator;
}
);
);

3
platform/core/src/models/MissingModelDecorator.js
View File

@ -30,6 +30,8 @@ define(
* Adds placeholder domain object models for any models which
* fail to load from the underlying model service.
* @implements {ModelService}
* @constructor
* @memberof platform/core
*/
function MissingModelDecorator(modelService) {
function missingModel(id) {
@ -57,3 +59,4 @@ define(
return MissingModelDecorator;
}
);

4
platform/core/src/models/ModelAggregator.js
View File

@ -33,6 +33,7 @@ define(
* Allows multiple services which provide models for domain objects
* to be treated as one.
*
* @memberof platform/core
* @constructor
* @param {ModelProvider[]} providers the model providers to be
* aggregated
@ -77,6 +78,7 @@ define(
* containing key-value pairs,
* where keys are object identifiers and values
* are object models.
* @memberof platform/core.ModelAggregator#
*/
getModels: function (ids) {
return $q.all(providers.map(function (provider) {
@ -90,4 +92,4 @@ define(
return ModelAggregator;
}
);
);

4
platform/core/src/models/PersistedModelProvider.js
View File

@ -33,6 +33,7 @@ define(
* A model service which reads domain object models from an external
* persistence service.
*
* @memberof platform/core
* @constructor
* @param {PersistenceService} persistenceService the service in which
* domain object models are persisted.
@ -83,6 +84,7 @@ define(
* containing key-value pairs,
* where keys are object identifiers and values
* are object models.
* @memberof platform/core.PersistedModelProvider#
*/
getModels: promiseModels
};
@ -91,4 +93,4 @@ define(
return PersistedModelProvider;
}
);
);

4
platform/core/src/models/RootModelProvider.js
View File

@ -39,6 +39,7 @@ define(
* exposes them all as composition of the root object ROOT,
* whose model is also provided by this service.
*
* @memberof platform/core
* @constructor
*/
function RootModelProvider(roots, $q, $log) {
@ -68,6 +69,7 @@ define(
* containing key-value pairs,
* where keys are object identifiers and values
* are object models.
* @memberof platform/core.RootModelProvider#
*/
getModels: function (ids) {
return baseProvider.getModels(ids).then(addRoot);
@ -77,4 +79,4 @@ define(
return RootModelProvider;
}
);
);

4
platform/core/src/models/StaticModelProvider.js
View File

@ -31,6 +31,7 @@ define(
/**
* Loads static models, provided as declared extensions of bundles.
* @memberof platform/core
* @constructor
*/
function StaticModelProvider(models, $q, $log) {
@ -69,6 +70,7 @@ define(
* ids and values are models
* @method
* @memberof StaticModelProvider#
* @memberof platform/core.StaticModelProvider#
*/
getModels: function (ids) {
var result = {};
@ -82,4 +84,4 @@ define(
return StaticModelProvider;
}
);
);