ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-21 16:49:42 +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

5
platform/framework/src/resolve/BundleResolver.js
View File

@ -34,6 +34,7 @@ define(
* initialization. During this phase, any scripts implementing
* extensions provided by bundles are loaded.
*
* @memberof platform/framework
* @constructor
*/
function BundleResolver(extensionResolver, requireConfigurator, $log) {
@ -47,6 +48,7 @@ define(
*
* @param {Object.<string, object[]>|Array} resolvedBundles
* @returns {Object.<string, object[]>}
* @memberof platform/framework.BundleResolver#
*/
function mergeResolvedBundles(resolvedBundles) {
var result = {};
@ -107,6 +109,7 @@ define(
* key-value pairs, where keys are extension
* categories and values are arrays of resolved
* extensions belonging to those categories
* @memberof platform/framework.BundleResolver#
*/
resolveBundles: function (bundles) {
// First, make sure Require is suitably configured
@ -121,4 +124,4 @@ define(
return BundleResolver;
}
);
);

4
platform/framework/src/resolve/ExtensionResolver.js
View File

@ -35,6 +35,7 @@ define(
*
* @param {ImplementationLoader} loader used to load implementations
* @param {*} $log Angular's logging service
* @memberof platform/framework
* @constructor
*/
function ExtensionResolver(loader, $log) {
@ -111,6 +112,7 @@ define(
* will additionally be attached to any loaded implementation.
*
* @param {Extension} extension
* @memberof platform/framework.ExtensionResolver#
*/
resolve: function (extension) {
// Log that loading has begun
@ -128,4 +130,4 @@ define(
return ExtensionResolver;
}
);
);

4
platform/framework/src/resolve/ImplementationLoader.js
View File

@ -33,6 +33,7 @@ define(
* Responsible for loading extension implementations
* (AMD modules.) Acts as a wrapper around RequireJS to
* provide a promise-like API.
* @memberof platform/framework
* @constructor
* @param {*} require RequireJS, or an object with similar API
* @param {*} $log Angular's logging service
@ -57,6 +58,7 @@ define(
* @memberof ImplementationLoader#
* @param {string} path the path to the module to load
* @returns {Promise} a promise for the specified module.
* @memberof platform/framework.ImplementationLoader#
*/
load: loadModule
};
@ -64,4 +66,4 @@ define(
return ImplementationLoader;
}
);
);

4
platform/framework/src/resolve/RequireConfigurator.js
View File

@ -30,6 +30,7 @@ define(
* Handles configuration of RequireJS to expose libraries
* from bundles with module names that can be used from other
* bundles.
* @memberof platform/framework
* @constructor
* @param requirejs an instance of RequireJS
*/
@ -99,6 +100,7 @@ define(
*
* @param {Bundle[]} the bundles to include in this
* configuration
* @memberof platform/framework.RequireConfigurator#
*/
configure: function (bundles) {
return requirejs.config(buildConfiguration(bundles));
@ -109,4 +111,4 @@ define(
return RequireConfigurator;
}
);
);