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