mirror of
https://github.com/nasa/openmct.git
synced 2025-01-25 21:59:23 +00:00
[About] Add JSDoc
Add in-line documentation to controllers introduced to support the About dialog. WTD-667.
This commit is contained in:
parent
d33344dacd
commit
f7a33659b4
@ -5,12 +5,33 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The AboutController provides information to populate the
|
||||||
|
* About dialog.
|
||||||
|
* @constructor
|
||||||
|
* @param {object[]} versions an array of version extensions;
|
||||||
|
* injected from `versions[]`
|
||||||
|
* @param $window Angular-injected window object
|
||||||
|
*/
|
||||||
function AboutController(versions, $window) {
|
function AboutController(versions, $window) {
|
||||||
return {
|
return {
|
||||||
|
/**
|
||||||
|
* Get version info. This is given as an array of
|
||||||
|
* objects, where each object is intended to appear
|
||||||
|
* as a line-item in the version information listing.
|
||||||
|
* @memberof AboutController#
|
||||||
|
* @returns {object[]} version information
|
||||||
|
*/
|
||||||
versions: function () {
|
versions: function () {
|
||||||
return versions;
|
return versions;
|
||||||
},
|
},
|
||||||
|
/**
|
||||||
|
* Open a new window (or tab, depending on browser
|
||||||
|
* configuration) containing open source licenses.
|
||||||
|
* @memberof AboutController#
|
||||||
|
*/
|
||||||
openLicenses: function () {
|
openLicenses: function () {
|
||||||
|
// Open a new browser window at the licenses route
|
||||||
$window.open("#/licenses");
|
$window.open("#/licenses");
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -5,8 +5,18 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The LogoController provides functionality to the application
|
||||||
|
* logo in the bottom-right of the user interface.
|
||||||
|
* @constructor
|
||||||
|
* @param {OverlayService} overlayService the overlay service
|
||||||
|
*/
|
||||||
function LogoController(overlayService) {
|
function LogoController(overlayService) {
|
||||||
return {
|
return {
|
||||||
|
/**
|
||||||
|
* Display the About dialog.
|
||||||
|
* @memberof LogoController#
|
||||||
|
*/
|
||||||
showAboutDialog: function () {
|
showAboutDialog: function () {
|
||||||
overlayService.createOverlay("overlay-about");
|
overlayService.createOverlay("overlay-about");
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user