diff --git a/platform/commonUI/about/src/AboutController.js b/platform/commonUI/about/src/AboutController.js index 6eb2171d34..77c6ede2cb 100644 --- a/platform/commonUI/about/src/AboutController.js +++ b/platform/commonUI/about/src/AboutController.js @@ -5,12 +5,33 @@ define( function () { "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) { 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 () { return versions; }, + /** + * Open a new window (or tab, depending on browser + * configuration) containing open source licenses. + * @memberof AboutController# + */ openLicenses: function () { + // Open a new browser window at the licenses route $window.open("#/licenses"); } }; diff --git a/platform/commonUI/about/src/LogoController.js b/platform/commonUI/about/src/LogoController.js index 93f425d1d7..1ff6b7602f 100644 --- a/platform/commonUI/about/src/LogoController.js +++ b/platform/commonUI/about/src/LogoController.js @@ -5,8 +5,18 @@ define( function () { "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) { return { + /** + * Display the About dialog. + * @memberof LogoController# + */ showAboutDialog: function () { overlayService.createOverlay("overlay-about"); }