[JSDoc] Add class-level documentation

This commit is contained in:
larkin 2015-06-12 10:08:34 -07:00
parent d32c05a313
commit bff272e326
7 changed files with 35 additions and 1 deletions

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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) {
/** /**

View File

@ -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 {
/** /**

View File

@ -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

View File

@ -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 {
/** /**