ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-15 13:48:12 +00:00
Code Issues Actions 4 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

9
platform/features/layout/src/FixedController.js
View File

@ -34,6 +34,7 @@ define(
* Fixed Position view. It arranges frames according to saved
* configuration and provides methods for updating these based on
* mouse movement.
* @memberof platform/features/layout
* @constructor
* @param {Scope} $scope the controller's Angular scope
*/
@ -290,6 +291,7 @@ define(
* Get the size of the grid, in pixels. The returned array
* is in the form `[x, y]`.
* @returns {number[]} the grid size
* @memberof platform/features/layout.FixedController#
*/
getGridSize: function () {
return gridSize;
@ -298,6 +300,7 @@ define(
* Get an array of elements in this panel; these are
* decorated proxies for both selection and display.
* @returns {Array} elements in this panel
* @memberof platform/features/layout.FixedController#
*/
getElements: function () {
return elementProxies;
@ -306,6 +309,7 @@ define(
* Check if the element is currently selected, or (if no
* argument is supplied) get the currently selected element.
* @returns {boolean} true if selected
* @memberof platform/features/layout.FixedController#
*/
selected: function (element) {
return selection && ((arguments.length > 0) ?
@ -314,10 +318,12 @@ define(
/**
* Set the active user selection in this view.
* @param element the element to select
* @memberof platform/features/layout.FixedController#
*/
select: select,
/**
* Clear the current user selection.
* @memberof platform/features/layout.FixedController#
*/
clearSelection: function () {
if (selection) {
@ -329,6 +335,7 @@ define(
/**
* Get drag handles.
* @returns {Array} drag handles for the current selection
* @memberof platform/features/layout.FixedController#
*/
handles: function () {
return handles;
@ -336,6 +343,7 @@ define(
/**
* Get the handle to handle dragging to reposition an element.
* @returns {FixedDragHandle} the drag handle
* @memberof platform/features/layout.FixedController#
*/
moveHandle: function () {
return moveHandle;
@ -347,3 +355,4 @@ define(
return FixedController;
}
);