From bff272e3264ab50df5fc691726366bb074ff0645 Mon Sep 17 00:00:00 2001 From: larkin Date: Fri, 12 Jun 2015 10:08:34 -0700 Subject: [PATCH] [JSDoc] Add class-level documentation --- platform/entanglement/src/actions/CopyAction.js | 7 +++++++ platform/entanglement/src/actions/LinkAction.js | 6 ++++++ platform/entanglement/src/actions/MoveAction.js | 6 ++++++ platform/entanglement/src/services/CopyService.js | 5 +++++ platform/entanglement/src/services/LinkService.js | 5 +++++ platform/entanglement/src/services/LocationService.js | 2 +- platform/entanglement/src/services/MoveService.js | 5 +++++ 7 files changed, 35 insertions(+), 1 deletion(-) diff --git a/platform/entanglement/src/actions/CopyAction.js b/platform/entanglement/src/actions/CopyAction.js index b691c4ae03..aff8b94fb5 100644 --- a/platform/entanglement/src/actions/CopyAction.js +++ b/platform/entanglement/src/actions/CopyAction.js @@ -25,6 +25,13 @@ define( function () { "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) { var object, diff --git a/platform/entanglement/src/actions/LinkAction.js b/platform/entanglement/src/actions/LinkAction.js index 69dfd5df62..c6b4be100f 100644 --- a/platform/entanglement/src/actions/LinkAction.js +++ b/platform/entanglement/src/actions/LinkAction.js @@ -25,6 +25,12 @@ define( function () { "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) { var object, diff --git a/platform/entanglement/src/actions/MoveAction.js b/platform/entanglement/src/actions/MoveAction.js index 2d8bea706a..63f1517c56 100644 --- a/platform/entanglement/src/actions/MoveAction.js +++ b/platform/entanglement/src/actions/MoveAction.js @@ -25,6 +25,12 @@ define( function () { "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) { var object, diff --git a/platform/entanglement/src/services/CopyService.js b/platform/entanglement/src/services/CopyService.js index b7e10ba9ab..487568c475 100644 --- a/platform/entanglement/src/services/CopyService.js +++ b/platform/entanglement/src/services/CopyService.js @@ -26,6 +26,11 @@ define( function () { "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) { /** diff --git a/platform/entanglement/src/services/LinkService.js b/platform/entanglement/src/services/LinkService.js index 9e570a9e4e..acecab3b8d 100644 --- a/platform/entanglement/src/services/LinkService.js +++ b/platform/entanglement/src/services/LinkService.js @@ -26,6 +26,11 @@ define( function () { "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) { return { /** diff --git a/platform/entanglement/src/services/LocationService.js b/platform/entanglement/src/services/LocationService.js index 2fec2bd181..3e71011503 100644 --- a/platform/entanglement/src/services/LocationService.js +++ b/platform/entanglement/src/services/LocationService.js @@ -29,7 +29,7 @@ define( /** * The LocationService allows for easily prompting the user for a * location in the root tree. - */ + */ function LocationService(dialogService) { return { /** Prompt the user to select a location. Returns a promise diff --git a/platform/entanglement/src/services/MoveService.js b/platform/entanglement/src/services/MoveService.js index 206b5916af..e91d381453 100644 --- a/platform/entanglement/src/services/MoveService.js +++ b/platform/entanglement/src/services/MoveService.js @@ -26,6 +26,11 @@ define( function () { "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) { return { /**