mirror of
https://github.com/nasa/openmct.git
synced 2025-01-31 08:25:31 +00:00
[JSDoc] Add class-level documentation
This commit is contained in:
parent
d32c05a313
commit
bff272e326
@ -25,6 +25,13 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The CopyAction is available from context menus and allows a user to
|
||||||
|
* deep copy an object to another location of their choosing.
|
||||||
|
*
|
||||||
|
* @implements Action
|
||||||
|
*/
|
||||||
function CopyAction(locationService, copyService, context) {
|
function CopyAction(locationService, copyService, context) {
|
||||||
|
|
||||||
var object,
|
var object,
|
||||||
|
@ -25,6 +25,12 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The LinkAction is available from context menus and allows a user to
|
||||||
|
* link an object to another location of their choosing.
|
||||||
|
*
|
||||||
|
* @implements Action
|
||||||
|
*/
|
||||||
function LinkAction(locationService, linkService, context) {
|
function LinkAction(locationService, linkService, context) {
|
||||||
|
|
||||||
var object,
|
var object,
|
||||||
|
@ -25,6 +25,12 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The MoveAction is available from context menus and allows a user to
|
||||||
|
* move an object to another location of their choosing.
|
||||||
|
*
|
||||||
|
* @implements Action
|
||||||
|
*/
|
||||||
function MoveAction(locationService, moveService, context) {
|
function MoveAction(locationService, moveService, context) {
|
||||||
|
|
||||||
var object,
|
var object,
|
||||||
|
@ -26,6 +26,11 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CopyService provides an interface for deep copying objects from one
|
||||||
|
* location to another. It also provides a method for determining if
|
||||||
|
* an object can be copied to a specific location.
|
||||||
|
*/
|
||||||
function CopyService($q, creationService, policyService) {
|
function CopyService($q, creationService, policyService) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -26,6 +26,11 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* LinkService provides an interface for linking objects to additional
|
||||||
|
* locations. It also provides a method for determining if an object
|
||||||
|
* can be copied to a specific location.
|
||||||
|
*/
|
||||||
function LinkService(policyService) {
|
function LinkService(policyService) {
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
|
@ -29,7 +29,7 @@ define(
|
|||||||
/**
|
/**
|
||||||
* The LocationService allows for easily prompting the user for a
|
* The LocationService allows for easily prompting the user for a
|
||||||
* location in the root tree.
|
* location in the root tree.
|
||||||
*/
|
*/
|
||||||
function LocationService(dialogService) {
|
function LocationService(dialogService) {
|
||||||
return {
|
return {
|
||||||
/** Prompt the user to select a location. Returns a promise
|
/** Prompt the user to select a location. Returns a promise
|
||||||
|
@ -26,6 +26,11 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MoveService provides an interface for moving objects from one
|
||||||
|
* location to another. It also provides a method for determining if
|
||||||
|
* an object can be copied to a specific location.
|
||||||
|
*/
|
||||||
function MoveService(policyService, linkService) {
|
function MoveService(policyService, linkService) {
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
|
Loading…
x
Reference in New Issue
Block a user