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

5
platform/policy/src/PolicyActionDecorator.js
View File

@ -31,6 +31,8 @@ define(
* @param {PolicyService} policyService the service which provides
* policy decisions
* @param {ActionService} actionService the service to decorate
* @constructor
* @memberof platform/policy
*/
function PolicyActionDecorator(policyService, actionService) {
return {
@ -40,6 +42,7 @@ define(
* are deemed inapplicable by policy.
* @param context the context in which the action will occur
* @returns {Action[]} applicable actions
* @memberof platform/policy.PolicyActionDecorator#
*/
getActions: function (context) {
// Check if an action is allowed by policy.
@ -55,4 +58,4 @@ define(
return PolicyActionDecorator;
}
);
);

4
platform/policy/src/PolicyProvider.js
View File

@ -30,6 +30,7 @@ define(
* Provides an implementation of `policyService` which consults
* various policy extensions to determine whether or not a specific
* decision should be allowed.
* @memberof platform/policy
* @constructor
*/
function PolicyProvider(policies) {
@ -74,6 +75,7 @@ define(
* was disallowed (if its disallowed)
* @returns {boolean} true if the decision is allowed,
* otherwise false.
* @memberof platform/policy.PolicyProvider#
*/
allow: function (category, candidate, context, callback) {
var policyList = policyMap[category] || [],
@ -103,4 +105,4 @@ define(
return PolicyProvider;
}
);
);

5
platform/policy/src/PolicyViewDecorator.js
View File

@ -31,6 +31,8 @@ define(
* @param {PolicyService} policyService the service which provides
* policy decisions
* @param {ViewService} viewService the service to decorate
* @constructor
* @memberof platform/policy
*/
function PolicyActionDecorator(policyService, viewService) {
return {
@ -40,6 +42,7 @@ define(
* are deemed inapplicable by policy.
* @param {DomainObject} the domain object to view
* @returns {View[]} applicable views
* @memberof platform/policy.PolicyViewDecorator#
*/
getViews: function (domainObject) {
// Check if an action is allowed by policy.
@ -55,4 +58,4 @@ define(
return PolicyActionDecorator;
}
);
);