[Cleanup] Files.app: Adds missing JSdoc annotations in file_manager/*.js.

chrome/browser/resources/file_manager/js/file_selection.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * The current selection object.
+ *
  * @param {FileManager} fileManager FileManager instance.
  * @param {Array.<number>} indexes Selected indexes.
+ * @constructor
  */
 function FileSelection(fileManager, indexes) {
   this.fileManager_ = fileManager;
   this.indexes = indexes;
   this.entries = [];
   this.urls = [];
   this.totalCount = 0;
   this.fileCount = 0;
   this.directoryCount = 0;
   this.bytes = 0;
@@ skipping 26 matching lines @@
       this.directoryCount += 1;
     }
     this.totalCount++;
   }
 
   this.tasks = new FileTasks(this.fileManager_);
 }
 
 /**
  * Computes data required to get file tasks and requests the tasks.
+ *
  * @param {function} callback The callback.
  */
 FileSelection.prototype.createTasks = function(callback) {
   if (!this.fileManager_.isOnDrive()) {
     this.tasks.init(this.urls);
     callback();
     return;
   }
 
   this.fileManager_.metadataCache_.get(this.urls, 'drive', function(props) {
     var present = props.filter(function(p) { return p && p.availableOffline });
     this.allDriveFilesPresent = present.length == props.length;
 
     // Collect all of the mime types and push that info into the selection.
     this.mimeTypes = props.map(function(value) {
       return (value && value.contentMimeType) || '';
     });
 
     this.tasks.init(this.urls, this.mimeTypes);
     callback();
   }.bind(this));
 };
 
 /**
  * Computes the total size of selected files.
+ *
  * @param {function} callback The callback.
  */
 FileSelection.prototype.computeBytes = function(callback) {
   if (this.entries.length == 0) {
     this.bytesKnown = true;
     this.bytes = 0;
     return;
   }
 
   var countdown = this.entries.length;
@@ skipping 26 matching lines @@
     return !this.cancelled_;
   }.bind(this);
 
   for (var index = 0; index < this.entries.length; index++) {
     util.forEachEntryInTree(this.entries[index], onEntry);
   }
 };
 
 /**
  * Cancels any async computation.
+ *
  * @private
  */
 FileSelection.prototype.cancelComputing_ = function() {
   this.cancelled_ = true;
 };
 
 /**
  * This object encapsulates everything related to current selection.
+ *
  * @param {FileManager} fileManager File manager instance.
+ * @constructor
  */
 function FileSelectionHandler(fileManager) {
   this.fileManager_ = fileManager;
   // TODO(dgozman): create a shared object with most of UI elements.
   this.okButton_ = fileManager.okButton_;
   this.filenameInput_ = fileManager.filenameInput_;
 
   this.previewPanel_ = fileManager.dialogDom_.querySelector('.preview-panel');
   this.previewThumbnails_ = this.previewPanel_.
       querySelector('.preview-thumbnails');
   this.previewSummary_ = this.previewPanel_.querySelector('.preview-summary');
   this.previewText_ = this.previewSummary_.querySelector('.preview-text');
   this.calculatingSize_ = this.previewSummary_.
       querySelector('.calculating-size');
   this.calculatingSize_.textContent = str('CALCULATING_SIZE');
 
   this.searchBreadcrumbs_ = fileManager.searchBreadcrumbs_;
   this.taskItems_ = fileManager.taskItems_;
 
   this.animationTimeout_ = null;
 }
 
 /**
  * Maximum amount of thumbnails in the preview pane.
+ *
+ * @const
+ * @type {number}
  */
 FileSelectionHandler.MAX_PREVIEW_THUMBNAIL_COUNT = 4;
 
 /**
  * Maximum width or height of an image what pops up when the mouse hovers
  * thumbnail in the bottom panel (in pixels).
+ *
+ * @const
+ * @type {number}
  */
 FileSelectionHandler.IMAGE_HOVER_PREVIEW_SIZE = 200;
 
 /**
  * Update the UI when the selection model changes.
  *
  * @param {cr.Event} event The change event.
  */
 FileSelectionHandler.prototype.onFileSelectionChanged = function(event) {
   var indexes =
@@ skipping 53 matching lines @@
 FileSelectionHandler.prototype.clearUI = function() {
   this.previewThumbnails_.textContent = '';
   this.previewText_.textContent = '';
   this.hideCalculating_();
   this.taskItems_.hidden = true;
   this.okButton_.disabled = true;
 };
 
 /**
  * Updates the Ok button enabled state.
+ *
  * @return {boolean} Whether button is enabled.
  */
 FileSelectionHandler.prototype.updateOkButton = function() {
   var selectable;
   var dialogType = this.fileManager_.dialogType;
 
   if (dialogType == DialogType.SELECT_FOLDER) {
     // In SELECT_FOLDER mode, we allow to select current directory
     // when nothing is selected.
     selectable = this.selection.directoryCount <= 1 &&
@@ skipping 20 matching lines @@
   }
 
   this.okButton_.disabled = !selectable;
   return selectable;
 };
 
 /**
   * Check if all the files in the current selection are available. The only
   * case when files might be not available is when the selection contains
   * uncached Drive files and the browser is offline.
+  *
   * @return {boolean} True if all files in the current selection are
   *                   available.
   */
 FileSelectionHandler.prototype.isFileSelectionAvailable = function() {
   return !this.fileManager_.isOnDrive() ||
       !this.fileManager_.isDriveOffline() ||
       this.selection.allDriveFilesPresent;
 };
 
 /**
  * Animates preview panel show/hide transitions.
+ *
  * @private
  */
 FileSelectionHandler.prototype.updatePreviewPanelVisibility_ = function() {
   var panel = this.previewPanel_;
   var state = panel.getAttribute('visibility');
   var mustBeVisible = (this.selection.totalCount > 0);
   var self = this;
   var fm = this.fileManager_;
 
   var stopHidingAndShow = function() {
@@ skipping 41 matching lines @@
 /**
  * @return {boolean} True if space reserverd for the preview panel.
  * @private
  */
 FileSelectionHandler.prototype.isPreviewPanelVisibile_ = function() {
   return this.previewPanel_.getAttribute('visibility') != 'hidden';
 };
 
 /**
  * Update the selection summary in preview panel.
+ *
  * @private
  */
 FileSelectionHandler.prototype.updatePreviewPanelText_ = function() {
   var selection = this.selection;
   if (selection.totalCount == 0) {
     // We dont want to change the string during preview panel animating away.
     return;
   }
 
   var text = '';
@@ skipping 15 matching lines @@
     }
   } else {
     this.showCalculating_();
   }
 
   this.previewText_.textContent = text;
 };
 
 /**
  * Displays the 'calculating size' label.
+ *
  * @private
  */
 FileSelectionHandler.prototype.showCalculating_ = function() {
   if (this.animationTimeout_) {
     clearTimeout(this.animationTimeout_);
     this.animationTimeout_ = null;
   }
 
   var dotCount = 0;
 
@@ skipping 13 matching lines @@
   var start = function() {
     this.calculatingSize_.hidden = false;
     advance();
   }.bind(this);
 
   this.animationTimeout_ = setTimeout(start, 500);
 };
 
 /**
  * Hides the 'calculating size' label.
+ *
  * @private
  */
 FileSelectionHandler.prototype.hideCalculating_ = function() {
   if (this.animationTimeout_) {
     clearTimeout(this.animationTimeout_);
     this.animationTimeout_ = null;
   }
   this.calculatingSize_.hidden = true;
 };
 
 /**
  * Calculates async selection stats and updates secondary UI elements.
+ *
  * @param {FileSelection} selection The selection object.
  */
 FileSelectionHandler.prototype.updateFileSelectionAsync = function(selection) {
   if (this.selection != selection) return;
 
   // Update the file tasks.
   var onTasks = function() {
     if (this.selection != selection) return;
     selection.tasks.display(this.taskItems_);
     selection.tasks.updateMenuItem();
@@ skipping 31 matching lines @@
 
   // Inform tests it's OK to click buttons now.
   chrome.test.sendMessage('selection-change-complete');
 
   // Show thumbnails.
   this.showPreviewThumbnails_(selection);
 };
 
 /**
  * Renders preview thumbnails in preview panel.
+ *
  * @param {FileSelection} selection The selection object.
  * @private
  */
 FileSelectionHandler.prototype.showPreviewThumbnails_ = function(selection) {
   var thumbnails = [];
   var thumbnailCount = 0;
   var thumbnailLoaded = -1;
   var forcedShowTimeout = null;
   var thumbnailsHaveZoom = false;
   var self = this;
@@ skipping 66 matching lines @@
     }
   }
 
   forcedShowTimeout = setTimeout(showThumbnails,
       FileManager.THUMBNAIL_SHOW_DELAY);
   onThumbnailLoaded();
 };
 
 /**
  * Renders a thumbnail for the buttom panel.
+ *
  * @param {Entry} entry Entry to render for.
  * @param {Function} callback Callend when image loaded.
  * @return {HTMLDivElement} Created element.
  * @private
  */
 FileSelectionHandler.prototype.renderThumbnail_ = function(entry, callback) {
   var thumbnail = this.fileManager_.document_.createElement('div');
   FileGrid.decorateThumbnailBox(thumbnail,
                                 entry,
                                 this.fileManager_.metadataCache_,
                                 ThumbnailLoader.FillMode.FILL,
                                 callback);
   return thumbnail;
 };
 
 /**
  * Updates the search breadcrumbs.
+ *
  * @private
  */
 FileSelectionHandler.prototype.updateSearchBreadcrumbs_ = function() {
   var selectedIndexes =
       this.fileManager_.getCurrentList().selectionModel.selectedIndexes;
   if (selectedIndexes.length !== 1 ||
       !this.fileManager_.directoryModel_.isSearching()) {
     this.searchBreadcrumbs_.hide();
     return;
   }
@@ skipping 70 matching lines @@
   style.left = (boxWidth - imageWidth) / 2 + 'px';
   style.top = (boxHeight - imageHeight) / 2 + 'px';
   style.position = 'relative';
 
   util.applyTransform(largeImage, transform);
 
   largeImageBox.appendChild(largeImage);
   largeImageBox.style.zIndex = 1000;
   return true;
 };