[JSDoc] Add annotations

Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions

View File

@ -32,6 +32,8 @@ define(
/**
* Controller for the "Imagery" view of a domain object which
* provides image telemetry.
* @constructor
* @memberof platform/features/imagery
*/
function ImageryController($scope, telemetryHandler) {
var date = "",
@ -83,6 +85,7 @@ define(
* Get the time portion (hours, minutes, seconds) of the
* timestamp associated with the incoming image telemetry.
* @returns {string} the time
* @memberof platform/features/imagery.ImageryController#
*/
getTime: function () {
return time;
@ -91,6 +94,7 @@ define(
* Get the date portion (month, year) of the
* timestamp associated with the incoming image telemetry.
* @returns {string} the date
* @memberof platform/features/imagery.ImageryController#
*/
getDate: function () {
return date;
@ -100,6 +104,7 @@ define(
* to the timestamp associated with the incoming image
* telemetry.
* @returns {string} the time
* @memberof platform/features/imagery.ImageryController#
*/
getZone: function () {
return "UTC";
@ -107,6 +112,7 @@ define(
/**
* Get the URL of the image telemetry to display.
* @returns {string} URL for telemetry image
* @memberof platform/features/imagery.ImageryController#
*/
getImageUrl: function () {
return imageUrl;
@ -116,6 +122,7 @@ define(
* paused, false means not.)
* @param {boolean} [state] the state to set
* @returns {boolean} the current state
* @memberof platform/features/imagery.ImageryController#
*/
paused: function (state) {
if (arguments.length > 0 && state !== paused) {
@ -131,3 +138,4 @@ define(
return ImageryController;
}
);

View File

@ -34,6 +34,8 @@ define(
*
* If `src` is falsy, no image will be displayed (immediately.)
*
* @constructor
* @memberof platform/features/imagery
*/
function MCTBackgroundImage($document) {
function link(scope, element, attrs) {
@ -87,3 +89,4 @@ define(
return MCTBackgroundImage;
}
);

View File

@ -29,6 +29,8 @@ define(
* Policy preventing the Imagery view from being made available for
* domain objects which do not have associated image telemetry.
* @implements {Policy}
* @constructor
* @memberof platform/features/imagery
*/
function ImageryViewPolicy() {
function hasImageTelemetry(domainObject) {
@ -57,3 +59,4 @@ define(
return ImageryViewPolicy;
}
);