ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-12 20:28:14 +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

4
platform/forms/src/MCTControl.js
View File

@ -33,6 +33,8 @@ define(
* `controls`; this allows plug-ins to introduce new form
* control types while still making use of the form
* generator to ensure an overall consistent form style.
* @constructor
* @memberof platform/forms
*/
function MCTControl(controls) {
var controlMap = {};
@ -103,4 +105,4 @@ define(
return MCTControl;
}
);
);

3
platform/forms/src/MCTForm.js
View File

@ -46,6 +46,7 @@ define(
* of name, except this will be made available in the
* parent scope.
*
* @memberof platform/forms
* @constructor
*/
function MCTForm() {
@ -82,4 +83,4 @@ define(
return MCTForm;
}
);
);

3
platform/forms/src/MCTToolbar.js
View File

@ -46,6 +46,7 @@ define(
* of name, except this will be made available in the
* parent scope.
*
* @memberof platform/forms
* @constructor
*/
function MCTForm() {
@ -82,4 +83,4 @@ define(
return MCTForm;
}
);
);

2
platform/forms/src/controllers/ColorController.js
View File

@ -99,4 +99,4 @@ define(
return ColorController;
}
);
);

4
platform/forms/src/controllers/CompositeController.js
View File

@ -35,6 +35,7 @@ define(
* filled in) should be disallowed. This is enforced in the template
* by an ng-required directive, but that is supported by the
* isNonEmpty check that this controller provides.
* @memberof platform/forms
* @constructor
*/
function CompositeController() {
@ -55,6 +56,7 @@ define(
* @param {Array} value the array to check
* @returns {boolean} true if any non-undefined
* element is in the array
* @memberof platform/forms.CompositeController#
*/
isNonEmpty: function (value) {
return Array.isArray(value) &&
@ -66,4 +68,4 @@ define(
return CompositeController;
}
);
);

2
platform/forms/src/controllers/DateTimeController.js
View File

@ -34,6 +34,7 @@ define(
* input fields but outputs a single timestamp (in
* milliseconds since start of 1970) to the ngModel.
*
* @memberof platform/forms
* @constructor
*/
function DateTimeController($scope) {
@ -106,3 +107,4 @@ define(
}
);

4
platform/forms/src/controllers/DialogButtonController.js
View File

@ -29,6 +29,7 @@ define(
* Controller for the `dialog-button` control type. Provides
* structure for a button (embedded via the template) which
* will show a dialog for editing a single property when clicked.
* @memberof platform/forms
* @constructor
* @param $scope the control's Angular scope
* @param {DialogService} dialogService service to use to prompt
@ -85,6 +86,7 @@ define(
* `button`; a dialog will be launched when this button
* is clicked.
* @returns dialog structure
* @memberof platform/forms.DialogButtonController#
*/
getButtonStructure: function () {
return buttonStructure;
@ -94,4 +96,4 @@ define(
return DialogButtonController;
}
);
);

3
platform/forms/src/controllers/FormController.js
View File

@ -31,6 +31,7 @@ define(
/**
* Controller for mct-form and mct-toolbar directives.
* @memberof platform/forms
* @constructor
*/
function FormController($scope) {
@ -75,4 +76,4 @@ define(
return FormController;
}
);
);