mirror of
https://github.com/nasa/openmct.git
synced 2025-06-13 04:38:15 +00:00
[JSDoc] Add annotations
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
@ -29,6 +29,7 @@ define(
|
||||
/**
|
||||
* The AboutController provides information to populate the
|
||||
* About dialog.
|
||||
* @memberof platform/commonUI/about
|
||||
* @constructor
|
||||
* @param {object[]} versions an array of version extensions;
|
||||
* injected from `versions[]`
|
||||
@ -42,6 +43,7 @@ define(
|
||||
* as a line-item in the version information listing.
|
||||
* @memberof AboutController#
|
||||
* @returns {object[]} version information
|
||||
* @memberof platform/commonUI/about.AboutController#
|
||||
*/
|
||||
versions: function () {
|
||||
return versions;
|
||||
@ -50,6 +52,7 @@ define(
|
||||
* Open a new window (or tab, depending on browser
|
||||
* configuration) containing open source licenses.
|
||||
* @memberof AboutController#
|
||||
* @memberof platform/commonUI/about.AboutController#
|
||||
*/
|
||||
openLicenses: function () {
|
||||
// Open a new browser window at the licenses route
|
||||
@ -60,4 +63,4 @@ define(
|
||||
|
||||
return AboutController;
|
||||
}
|
||||
);
|
||||
);
|
||||
|
@ -29,6 +29,7 @@ define(
|
||||
/**
|
||||
* Provides extension-introduced licenses information to the
|
||||
* licenses route.
|
||||
* @memberof platform/commonUI/about
|
||||
* @constructor
|
||||
*/
|
||||
function LicenseController(licenses) {
|
||||
@ -36,6 +37,7 @@ define(
|
||||
/**
|
||||
* Get license information.
|
||||
* @returns {Array} license extensions
|
||||
* @memberof platform/commonUI/about.LicenseController#
|
||||
*/
|
||||
licenses: function () {
|
||||
return licenses;
|
||||
@ -45,4 +47,4 @@ define(
|
||||
|
||||
return LicenseController;
|
||||
}
|
||||
);
|
||||
);
|
||||
|
@ -29,6 +29,7 @@ define(
|
||||
/**
|
||||
* The LogoController provides functionality to the application
|
||||
* logo in the bottom-right of the user interface.
|
||||
* @memberof platform/commonUI/about
|
||||
* @constructor
|
||||
* @param {OverlayService} overlayService the overlay service
|
||||
*/
|
||||
@ -37,6 +38,7 @@ define(
|
||||
/**
|
||||
* Display the About dialog.
|
||||
* @memberof LogoController#
|
||||
* @memberof platform/commonUI/about.LogoController#
|
||||
*/
|
||||
showAboutDialog: function () {
|
||||
overlayService.createOverlay("overlay-about");
|
||||
@ -46,4 +48,4 @@ define(
|
||||
|
||||
return LogoController;
|
||||
}
|
||||
);
|
||||
);
|
||||
|
Reference in New Issue
Block a user