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

3
platform/commonUI/general/src/StyleSheetLoader.js
View File

@ -29,6 +29,7 @@ define(
/**
* The StyleSheetLoader adds links to style sheets exposed from
* various bundles as extensions of category `stylesheets`.
* @memberof platform/commonUI/general
* @constructor
* @param {object[]} stylesheets stylesheet extension definitions
* @param $document Angular's jqLite-wrapped document element
@ -62,4 +63,4 @@ define(
return StyleSheetLoader;
}
);
);

3
platform/commonUI/general/src/controllers/ActionGroupController.js
View File

@ -42,6 +42,7 @@ define(
* * `ungrouped`: All actions which did not have a defined
* group.
*
* @memberof platform/commonUI/general
* @constructor
*/
function ActionGroupController($scope) {
@ -102,4 +103,4 @@ define(
return ActionGroupController;
}
);
);

4
platform/commonUI/general/src/controllers/BottomBarController.js
View File

@ -29,6 +29,7 @@ define(
/**
* Controller for the bottombar template. Exposes
* available indicators (of extension category "indicators")
* @memberof platform/commonUI/general
* @constructor
*/
function BottomBarController(indicators) {
@ -49,6 +50,7 @@ define(
* Get all indicators to display.
* @returns {Indicator[]} all indicators
* to display in the bottom bar.
* @memberof platform/commonUI/general.BottomBarController#
*/
getIndicators: function () {
return indicators;
@ -58,4 +60,4 @@ define(
return BottomBarController;
}
);
);

6
platform/commonUI/general/src/controllers/ClickAwayController.js
View File

@ -31,6 +31,7 @@ define(
* menus) where clicking elsewhere in the document while the toggle
* is in an active state is intended to dismiss the toggle.
*
* @memberof platform/commonUI/general
* @constructor
* @param $scope the scope in which this controller is active
* @param $document the document element, injected by Angular
@ -72,6 +73,7 @@ define(
/**
* Get the current state of the toggle.
* @return {boolean} true if active
* @memberof platform/commonUI/general.ClickAwayController#
*/
isActive: function () {
return state;
@ -79,6 +81,7 @@ define(
/**
* Set a new state for the toggle.
* @return {boolean} true to activate
* @memberof platform/commonUI/general.ClickAwayController#
*/
setState: function (newState) {
if (state !== newState) {
@ -88,6 +91,7 @@ define(
/**
* Toggle the current state; activate if it is inactive,
* deactivate if it is active.
* @memberof platform/commonUI/general.ClickAwayController#
*/
toggle: function () {
changeState();
@ -98,4 +102,4 @@ define(
return ClickAwayController;
}
);
);

3
platform/commonUI/general/src/controllers/ContextMenuController.js
View File

@ -33,6 +33,7 @@ define(
* Controller for the context menu. Maintains an up-to-date
* list of applicable actions (those from category "contextual")
*
* @memberof platform/commonUI/general
* @constructor
*/
function ContextMenuController($scope) {
@ -49,4 +50,4 @@ define(
return ContextMenuController;
}
);
);

3
platform/commonUI/general/src/controllers/GetterSetterController.js
View File

@ -54,6 +54,7 @@ define(
* parameter it received.) Getter-setter functions are never the
* target of a scope assignment and so avoid this problem.
*
* @memberof platform/commonUI/general
* @constructor
* @param {Scope} $scope the controller's scope
*/
@ -87,4 +88,4 @@ define(
return GetterSetterController;
}
);
);

7
platform/commonUI/general/src/controllers/SelectorController.js
View File

@ -30,6 +30,7 @@ define(
/**
* Controller for the domain object selector control.
* @memberof platform/commonUI/general
* @constructor
* @param {ObjectService} objectService service from which to
* read domain objects
@ -102,6 +103,7 @@ define(
/**
* Get the root object to show in the left-hand tree.
* @returns {DomainObject} the root object
* @memberof platform/commonUI/general.SelectorController#
*/
root: function () {
return rootObject;
@ -109,6 +111,7 @@ define(
/**
* Add a domain object to the list of selected objects.
* @param {DomainObject} the domain object to select
* @memberof platform/commonUI/general.SelectorController#
*/
select: function (domainObject) {
var id = domainObject && domainObject.getId(),
@ -122,6 +125,7 @@ define(
/**
* Remove a domain object from the list of selected objects.
* @param {DomainObject} the domain object to select
* @memberof platform/commonUI/general.SelectorController#
*/
deselect: function (domainObject) {
var id = domainObject && domainObject.getId(),
@ -140,6 +144,7 @@ define(
/**
* Get the currently-selected domain objects.
* @returns {DomainObject[]} the current selection
* @memberof platform/commonUI/general.SelectorController#
*/
selected: function () {
return selectedObjects;
@ -153,4 +158,4 @@ define(
return SelectorController;
}
);
);

6
platform/commonUI/general/src/controllers/SplitPaneController.js
View File

@ -32,6 +32,7 @@ define(
/**
* Controller for the splitter in Browse mode. Current implementation
* uses many hard-coded constants; this could be generalized.
* @memberof platform/commonUI/general
* @constructor
*/
function SplitPaneController() {
@ -44,6 +45,7 @@ define(
* Get the current position of the splitter, in pixels
* from the left edge.
* @returns {number} position of the splitter, in pixels
* @memberof platform/commonUI/general.SplitPaneController#
*/
state: function (defaultState) {
// Set the state to the desired default, if we don't have a
@ -58,6 +60,7 @@ define(
* Begin moving the splitter; this will note the splitter's
* current position, which is necessary for correct
* interpretation of deltas provided by mct-drag.
* @memberof platform/commonUI/general.SplitPaneController#
*/
startMove: function () {
start = current;
@ -68,6 +71,7 @@ define(
* This movement is relative to the position of the
* splitter when startMove was last invoked.
* @param {number} delta number of pixels to move
* @memberof platform/commonUI/general.SplitPaneController#
*/
move: function (delta, minimum, maximum) {
// Ensure defaults for minimum/maximum
@ -87,4 +91,4 @@ define(
return SplitPaneController;
}
);
);

6
platform/commonUI/general/src/controllers/ToggleController.js
View File

@ -30,6 +30,7 @@ define(
* A ToggleController is used to activate/deactivate things.
* A common usage is for "twistie"
*
* @memberof platform/commonUI/general
* @constructor
*/
function ToggleController() {
@ -39,6 +40,7 @@ define(
/**
* Get the current state of the toggle.
* @return {boolean} true if active
* @memberof platform/commonUI/general.ToggleController#
*/
isActive: function () {
return state;
@ -46,6 +48,7 @@ define(
/**
* Set a new state for the toggle.
* @return {boolean} true to activate
* @memberof platform/commonUI/general.ToggleController#
*/
setState: function (newState) {
state = newState;
@ -53,6 +56,7 @@ define(
/**
* Toggle the current state; activate if it is inactive,
* deactivate if it is active.
* @memberof platform/commonUI/general.ToggleController#
*/
toggle: function () {
state = !state;
@ -63,4 +67,4 @@ define(
return ToggleController;
}
);
);

6
platform/commonUI/general/src/controllers/TreeNodeController.js
View File

@ -48,6 +48,7 @@ define(
* node expansion when this tree node's _subtree_ will contain
* the navigated object (recursively, this becomes an
* expand-to-show-navigated-object behavior.)
* @memberof platform/commonUI/general
* @constructor
*/
function TreeNodeController($scope, $timeout, $rootScope) {
@ -148,11 +149,13 @@ define(
* This method should be called when a node is expanded
* to record that this has occurred, to support one-time
* lazy loading of the node's subtree.
* @memberof platform/commonUI/general.TreeNodeController#
*/
trackExpansion: trackExpansion,
/**
* Check if this not has ever been expanded.
* @returns true if it has been expanded
* @memberof platform/commonUI/general.TreeNodeController#
*/
hasBeenExpanded: function () {
return hasBeenExpanded;
@ -163,6 +166,7 @@ define(
* An object will be highlighted if it matches
* ngModel.selectedObject
* @returns true if this should be highlighted
* @memberof platform/commonUI/general.TreeNodeController#
*/
isSelected: function () {
return isSelected;
@ -172,4 +176,4 @@ define(
return TreeNodeController;
}
);
);

2
platform/commonUI/general/src/controllers/ViewSwitcherController.js
View File

@ -32,6 +32,7 @@ define(
/**
* Controller for the view switcher; populates and maintains a list
* of applicable views for a represented domain object.
* @memberof platform/commonUI/general
* @constructor
*/
function ViewSwitcherController($scope, $timeout) {
@ -71,3 +72,4 @@ define(
return ViewSwitcherController;
}
);

3
platform/commonUI/general/src/directives/MCTContainer.js
View File

@ -39,6 +39,7 @@ define(
* plain string attribute, instead of as an Angular
* expression.
*
* @memberof platform/commonUI/general
* @constructor
*/
function MCTContainer(containers) {
@ -96,4 +97,4 @@ define(
return MCTContainer;
}
);
);

2
platform/commonUI/general/src/directives/MCTDrag.js
View File

@ -44,6 +44,7 @@ define(
* and vertical pixel offset of the current mouse position
* relative to the mouse position where dragging began.
*
* @memberof platform/commonUI/general
* @constructor
*
*/
@ -157,3 +158,4 @@ define(
return MCTDrag;
}
);

3
platform/commonUI/general/src/directives/MCTResize.js
View File

@ -49,6 +49,7 @@ define(
* This is an Angular expression, and it will be re-evaluated after
* each interval.
*
* @memberof platform/commonUI/general
* @constructor
*
*/
@ -111,4 +112,4 @@ define(
return MCTResize;
}
);
);

3
platform/commonUI/general/src/directives/MCTScroll.js
View File

@ -37,6 +37,7 @@ define(
* This is exposed as two directives in `bundle.json`; the difference
* is handled purely by parameterization.
*
* @memberof platform/commonUI/general
* @constructor
* @param $parse Angular's $parse
* @param {string} property property to manage within the HTML element
@ -80,4 +81,4 @@ define(
return MCTScroll;
}
);
);

2
platform/commonUI/general/src/directives/MCTSplitPane.js
View File

@ -91,6 +91,7 @@ define(
* etc. can be set on that element to control the splitter's
* allowable positions.
*
* @memberof platform/commonUI/general
* @constructor
*/
function MCTSplitPane($parse, $log) {
@ -213,3 +214,4 @@ define(
}
);

2
platform/commonUI/general/src/directives/MCTSplitter.js
View File

@ -39,6 +39,7 @@ define(
/**
* Implements `mct-splitter` directive.
* @memberof platform/commonUI/general
* @constructor
*/
function MCTSplitter() {
@ -88,3 +89,4 @@ define(
}
);

6
platform/commonUI/general/src/services/UrlService.js
View File

@ -32,6 +32,8 @@ define(
/**
* The url service handles calls for url paths
* using domain objects.
* @constructor
* @memberof platform/commonUI/general
*/
function UrlService($location) {
// Returns the url for the mode wanted
@ -73,6 +75,7 @@ define(
* for the path
* @param {DomainObject} value of the domain object
* to get the path of
* @memberof platform/commonUI/general.UrlService#
*/
urlForNewTab: urlForNewTab,
/**
@ -83,6 +86,7 @@ define(
* for the path
* @param {DomainObject} value of the domain object
* to get the path of
* @memberof platform/commonUI/general.UrlService#
*/
urlForLocation: urlForLocation
};
@ -90,4 +94,4 @@ define(
return UrlService;
}
);
);