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

2
platform/commonUI/browse/src/BrowseController.js
View File

@ -39,6 +39,7 @@ define(
* which Angular templates first have access to the domain object
* hierarchy.
*
* @memberof platform/commonUI/browse
* @constructor
*/
function BrowseController($scope, $route, $location, objectService, navigationService, urlService) {
@ -157,3 +158,4 @@ define(
return BrowseController;
}
);

2
platform/commonUI/browse/src/BrowseObjectController.js
View File

@ -29,6 +29,7 @@ define(
/**
* Controller for the `browse-object` representation of a domain
* object (the right-hand side of Browse mode.)
* @memberof platform/commonUI/browse
* @constructor
*/
function BrowseObjectController($scope, $location, $route) {
@ -71,3 +72,4 @@ define(
return BrowseObjectController;
}
);

3
platform/commonUI/browse/src/MenuArrowController.js
View File

@ -33,6 +33,7 @@ define(
* A left-click on the menu arrow should display a
* context menu. This controller launches the context
* menu.
* @memberof platform/commonUI/browse
* @constructor
*/
function MenuArrowController($scope) {
@ -48,4 +49,4 @@ define(
return MenuArrowController;
}
);
);

5
platform/commonUI/browse/src/creation/CreateAction.js
View File

@ -34,6 +34,7 @@ define(
* domain objects of a specific type. This is the action that
* is performed when a user uses the Create menu.
*
* @memberof platform/commonUI/browse
* @constructor
* @param {Type} type the type of domain object to create
* @param {DomainObject} parent the domain object that should
@ -95,6 +96,7 @@ define(
* This will prompt for user input first.
* @method
* @memberof CreateAction
* @memberof platform/commonUI/browse.CreateAction#
*/
perform: perform,
@ -107,6 +109,7 @@ define(
* * `context`: The context in which this action will be performed.
*
* @return {object} metadata about the create action
* @memberof platform/commonUI/browse.CreateAction#
*/
getMetadata: function () {
return {
@ -123,4 +126,4 @@ define(
return CreateAction;
}
);
);

4
platform/commonUI/browse/src/creation/CreateActionProvider.js
View File

@ -33,6 +33,7 @@ define(
* The CreateActionProvider is an ActionProvider which introduces
* a Create action for each creatable domain object type.
*
* @memberof platform/commonUI/browse
* @constructor
* @param {TypeService} typeService the type service, used to discover
* available types
@ -51,6 +52,7 @@ define(
* @memberof CreateActionProvider
* @method
* @returns {CreateAction[]}
* @memberof platform/commonUI/browse.CreateActionProvider#
*/
getActions: function (actionContext) {
var context = actionContext || {},
@ -84,4 +86,4 @@ define(
return CreateActionProvider;
}
);
);

3
platform/commonUI/browse/src/creation/CreateMenuController.js
View File

@ -34,6 +34,7 @@ define(
* set of Create actions based on the currently-selected
* domain object.
*
* @memberof platform/commonUI/browse
* @constructor
*/
function CreateMenuController($scope) {
@ -55,4 +56,4 @@ define(
return CreateMenuController;
}
);
);

7
platform/commonUI/browse/src/creation/CreateWizard.js
View File

@ -37,6 +37,7 @@ define(
* @param {TypeImpl} type the type of domain object to be created
* @param {DomainObject} parent the domain object to serve as
* the initial parent for the created object, in the dialog
* @memberof platform/commonUI/browse
* @constructor
* @memberof module:core/action/create-wizard
*/
@ -62,6 +63,7 @@ define(
*
* @return {FormModel} formModel the form model to
* show in the create dialog
* @memberof platform/commonUI/browse.CreateWizard#
*/
getFormStructure: function () {
var sections = [];
@ -100,6 +102,7 @@ define(
* in the structure.
*
* @returns {object} the initial value of the form
* @memberof platform/commonUI/browse.CreateWizard#
*/
getInitialFormValue: function () {
// Start with initial values for properties
@ -116,6 +119,7 @@ define(
* Based on a populated form, get the domain object which
* should be used as a parent for the newly-created object.
* @return {DomainObject}
* @memberof platform/commonUI/browse.CreateWizard#
*/
getLocation: function (formValue) {
return formValue.createParent || parent;
@ -124,6 +128,7 @@ define(
* Create the domain object model for a newly-created object,
* based on user input read from a formModel.
* @return {object} the domain object' model
* @memberof platform/commonUI/browse.CreateWizard#
*/
createModel: function (formValue) {
// Clone
@ -146,4 +151,4 @@ define(
return CreateWizard;
}
);
);

3
platform/commonUI/browse/src/creation/CreationService.js
View File

@ -39,6 +39,7 @@ define(
* persisting new domain objects. Handles all actual object
* mutation and persistence associated with domain object
* creation.
* @memberof platform/commonUI/browse
* @constructor
*/
function CreationService(persistenceService, $q, $log) {
@ -131,6 +132,7 @@ define(
* @param {DomainObject} parent the domain object which
* should contain the newly-created domain object
* in its composition
* @memberof platform/commonUI/browse.CreationService#
*/
createObject: createObject
};
@ -139,3 +141,4 @@ define(
return CreationService;
}
);

2
platform/commonUI/browse/src/creation/LocatorController.js
View File

@ -30,6 +30,7 @@ define(
* Controller for the "locator" control, which provides the
* user with the ability to select a domain object as the
* destination for a newly-created object in the Create menu.
* @memberof platform/commonUI/browse
* @constructor
*/
function LocatorController($scope) {
@ -79,3 +80,4 @@ define(
return LocatorController;
}
);

4
platform/commonUI/browse/src/navigation/NavigateAction.js
View File

@ -31,6 +31,7 @@ define(
/**
* The navigate action navigates to a specific domain object.
* @memberof platform/commonUI/browse
* @constructor
*/
function NavigateAction(navigationService, $q, context) {
@ -46,6 +47,7 @@ define(
* Navigate to the object described in the context.
* @returns {Promise} a promise that is resolved once the
* navigation has been updated
* @memberof platform/commonUI/browse.NavigateAction#
*/
perform: perform
};
@ -64,4 +66,4 @@ define(
return NavigateAction;
}
);
);

7
platform/commonUI/browse/src/navigation/NavigationService.js
View File

@ -32,6 +32,7 @@ define(
/**
* The navigation service maintains the application's current
* navigation state, and allows listening for changes thereto.
* @memberof platform/commonUI/browse
* @constructor
*/
function NavigationService() {
@ -68,12 +69,14 @@ define(
return {
/**
* Get the current navigation state.
* @memberof platform/commonUI/browse.NavigationService#
*/
getNavigation: getNavigation,
/**
* Set the current navigation state. Thiswill invoke listeners.
* @param {DomainObject} value the domain object to navigate
* to
* @memberof platform/commonUI/browse.NavigationService#
*/
setNavigation: setNavigation,
/**
@ -82,6 +85,7 @@ define(
* this changes.
* @param {function} callback the callback to invoke when
* navigation state changes
* @memberof platform/commonUI/browse.NavigationService#
*/
addListener: addListener,
/**
@ -89,6 +93,7 @@ define(
* @param {function} callback the callback which should
* no longer be invoked when navigation state
* changes
* @memberof platform/commonUI/browse.NavigationService#
*/
removeListener: removeListener
};
@ -96,4 +101,4 @@ define(
return NavigationService;
}
);
);

5
platform/commonUI/browse/src/windowing/FullscreenAction.js
View File

@ -35,12 +35,14 @@ define(
/**
* The fullscreen action toggles between fullscreen display
* and regular in-window display.
* @memberof platform/commonUI/browse
* @constructor
*/
function FullscreenAction(context) {
return {
/**
* Toggle full screen state
* @memberof platform/commonUI/browse.FullscreenAction#
*/
perform: function () {
screenfull.toggle();
@ -48,6 +50,7 @@ define(
/**
* Get metadata about this action, including the
* applicable glyph to display.
* @memberof platform/commonUI/browse.FullscreenAction#
*/
getMetadata: function () {
// We override getMetadata, because the glyph and
@ -67,4 +70,4 @@ define(
return FullscreenAction;
}
);
);

3
platform/commonUI/browse/src/windowing/NewTabAction.js
View File

@ -33,6 +33,7 @@ define(
/**
* The new tab action allows a domain object to be opened
* into a new browser tab.
* @memberof platform/commonUI/browse
* @constructor
*/
function NewTabAction(urlService, $window, context) {
@ -64,4 +65,4 @@ define(
return NewTabAction;
}
);
);

3
platform/commonUI/browse/src/windowing/WindowTitler.js
View File

@ -29,6 +29,7 @@ define(
/**
* Updates the title of the current window to reflect the name
* of the currently navigated-to domain object.
* @memberof platform/commonUI/browse
* @constructor
*/
function WindowTitler(navigationService, $rootScope, $document) {
@ -49,4 +50,4 @@ define(
return WindowTitler;
}
);
);