[About] Add JSDoc

Add in-line documentation to controllers introduced to
support the About dialog. WTD-667.
This commit is contained in:
Victor Woeltjen 2015-01-14 13:15:24 -08:00
parent d33344dacd
commit f7a33659b4
2 changed files with 31 additions and 0 deletions

View File

@ -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");
}
};

View File

@ -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");
}