ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-13 04:38:15 +00:00
Code Issues Actions 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/commonUI/edit/src/capabilities/EditableCompositionCapability.js
View File

@ -35,6 +35,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
return function EditableCompositionCapability(
contextCapability,
@ -54,4 +56,4 @@ define(
);
};
}
);
);

4
platform/commonUI/edit/src/capabilities/EditableContextCapability.js
View File

@ -35,6 +35,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
return function EditableContextCapability(
contextCapability,
@ -72,4 +74,4 @@ define(
return capability;
};
}
);
);

4
platform/commonUI/edit/src/capabilities/EditableLookupCapability.js
View File

@ -35,6 +35,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
return function EditableLookupCapability(
contextCapability,
@ -115,4 +117,4 @@ define(
return capability;
};
}
);
);

4
platform/commonUI/edit/src/capabilities/EditablePersistenceCapability.js
View File

@ -35,6 +35,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
function EditablePersistenceCapability(
persistenceCapability,
@ -62,4 +64,4 @@ define(
return EditablePersistenceCapability;
}
);
);

4
platform/commonUI/edit/src/capabilities/EditableRelationshipCapability.js
View File

@ -35,6 +35,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
return function EditableRelationshipCapability(
relationshipCapability,
@ -54,4 +56,4 @@ define(
);
};
}
);
);

7
platform/commonUI/edit/src/capabilities/EditorCapability.js
View File

@ -39,6 +39,8 @@ define(
* Meant specifically for use by EditableDomainObject and the
* associated cache; the constructor signature is particular
* to a pattern used there and may contain unused arguments.
* @constructor
* @memberof platform/commonUI/edit
*/
return function EditorCapability(
persistenceCapability,
@ -83,6 +85,7 @@ define(
* object (and not other objects with associated changes)
* @returns {Promise} a promise that will be fulfilled after
* persistence has completed.
* @memberof platform/commonUI/edit.EditorCapability#
*/
save: function (nonrecursive) {
return nonrecursive ?
@ -95,6 +98,7 @@ define(
* been retrieved and modified during the editing session)
* @returns {Promise} a promise that will be fulfilled after
* cancellation has completed.
* @memberof platform/commonUI/edit.EditorCapability#
*/
cancel: function () {
return resolvePromise(undefined);
@ -102,6 +106,7 @@ define(
/**
* Check if there are any unsaved changes.
* @returns {boolean} true if there are unsaved changes
* @memberof platform/commonUI/edit.EditorCapability#
*/
dirty: function () {
return cache.dirty();
@ -109,4 +114,4 @@ define(
};
};
}
);
);