Add missing type comments for file_manager_commands.js

ui/file_manager/file_manager/foreground/js/file_manager_commands.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.
 
 /**
  * TODO(dzvorygin): Here we use this hack, since 'hidden' is standard
  * attribute and we can't use it's setter as usual.
  * @param {boolean} value New value of hidden property.
  */
 cr.ui.Command.prototype.setHidden = function(value) {
@@ skipping 163 matching lines @@
     if (event.command.id === commandId)
       event.canExecute = document.queryCommandEnabled(event.command.id);
   });
 };
 
 /**
  * Default command.
  * @type {Command}
  */
 CommandUtil.defaultCommand = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.

[fukino, 2014/10/31 07:04:21]

Could you make these parameter type non-nullable?

[hirono, 2014/10/31 07:47:29]

Done.

+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.document.execCommand(event.command.id);
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     event.canExecute = fileManager.document.queryCommandEnabled(
         event.command.id);
   }
 });
 
 /**
  * Creates the volume switch command with index.
  * @param {number} index Volume index from 1 to 9.
  * @return {Command} Volume switch command.
  */
 CommandUtil.createVolumeSwitchCommand = function(index) {
   return /** @type {Command} */ ({
+    /**
+     * @param {Event} event Command event.
+     * @param {FileManager} fileManager FileManager to use.
+     */
     execute: function(event, fileManager) {
       fileManager.directoryTree.selectByIndex(index - 1);
     },
+    /**
+     * @param {Event} event Command event.
+     * @param {FileManager} fileManager FileManager to use.
+     */
     canExecute: function(event, fileManager) {
       event.canExecute = index > 0 &&
           index <= fileManager.directoryTree.items.length;
     }
   });
 };
 
 /**
  * Returns a directory entry when only one entry is selected and it is
  * directory. Otherwise, returns null.
@@ skipping 205 matching lines @@
     event.canExecute = removable && !isReadOnly;
     event.command.setHidden(!removable);
   }
 });
 
 /**
  * Initiates new folder creation.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['new-folder'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.createNewFolder();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var directoryModel = fileManager.directoryModel;
     event.canExecute = !fileManager.isOnReadonlyDirectory() &&
                        !fileManager.isRenamingInProgress() &&
                        !directoryModel.isSearching() &&
                        !directoryModel.isScanning();
   }
 });
 
 /**
  * Initiates new window creation.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['new-window'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.getProfiles(
         function(profiles, currentId, displayedId) {
           fileManager.backgroundPage.launchFileManager({
             currentDirectoryURL: fileManager.getCurrentDirectoryEntry() &&
                 fileManager.getCurrentDirectoryEntry().toURL(),
             displayedId: currentId !== displayedId ? displayedId : undefined
           });
         });
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     event.canExecute =
         fileManager.getCurrentDirectoryEntry() &&
         (fileManager.dialogType === DialogType.FULL_PAGE);
   }
 });
 
 /**
  * Toggles drive sync settings.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['drive-sync-settings'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.toggleDriveSyncSettings();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     event.canExecute = fileManager.shouldShowDriveSettings();
     event.command.setHidden(!event.canExecute);
   }
 });
 
 /**
  * Toggles drive hosted settings.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['drive-hosted-settings'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.toggleDriveHostedSettings();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     event.canExecute = fileManager.shouldShowDriveSettings();
     event.command.setHidden(!event.canExecute);
   }
 });
 
 /**
  * Deletes selected files.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['delete'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     var entries = fileManager.getSelection().entries;
     var message = entries.length == 1 ?
         strf('GALLERY_CONFIRM_DELETE_ONE', entries[0].name) :
         strf('GALLERY_CONFIRM_DELETE_SOME', entries.length);
     fileManager.ui.deleteConfirmDialog.show(message, function() {
       fileManager.fileOperationManager.deleteEntries(entries);
     });
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var selection = fileManager.getSelection();
     event.canExecute = !fileManager.isOnReadonlyDirectory() &&
                        selection &&
                        selection.totalCount > 0;
   }
 });
 
 /**
  * Pastes files from clipboard.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['paste'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.document.execCommand(event.command.id);
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var fileTransferController = fileManager.fileTransferController;
     event.canExecute = (fileTransferController &&
         fileTransferController.queryPasteCommandEnabled());
     // Hide this command if only one folder is selected.
     event.command.setHidden(!!CommandUtil.getOnlyOneSelectedDirectory(
         fileManager.getSelection()));
   }
 });
 
 /**
  * Pastes files from clipboard into the selected folder.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['paste-into-folder'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     var selection = fileManager.getSelection();
     var dest = CommandUtil.getOnlyOneSelectedDirectory(selection);
     if (!dest) return;
 
     // This handler tweaks the Event object for 'paste' event so that
     // the FileTransferController can distinguish this 'paste-into-folder'
     // command and know the destination directory.
     var handler = function(inEvent) {
       inEvent.destDirectory = dest;
     };
     fileManager.document.addEventListener('paste', handler, true);
     fileManager.document.execCommand('paste');
     fileManager.document.removeEventListener('paste', handler, true);
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var fileTransferController = fileManager.fileTransferController;
     event.canExecute = (fileTransferController &&
         fileTransferController.queryPasteCommandEnabled());
     // Hide this command unless only one folder is selected.
     event.command.setHidden(!CommandUtil.getOnlyOneSelectedDirectory(
         fileManager.getSelection()));
   }
 });
 
 CommandHandler.COMMANDS_['cut'] = CommandUtil.defaultCommand;
 CommandHandler.COMMANDS_['copy'] = CommandUtil.defaultCommand;
 
 /**
  * Initiates file renaming.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['rename'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.initiateRename();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var selection = fileManager.getSelection();
     event.canExecute = !fileManager.isRenamingInProgress() &&
                        !fileManager.isOnReadonlyDirectory() &&
                        selection &&
                        selection.totalCount == 1;
   }
 });
 
 /**
  * Opens drive help.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['volume-help'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     if (fileManager.isOnDrive())
       util.visitURL(str('GOOGLE_DRIVE_HELP_URL'));
     else
       util.visitURL(str('FILES_APP_HELP_URL'));
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     // Hides the help menu in modal dialog mode. It does not make much sense
     // because after all, users cannot view the help without closing, and
     // besides that the help page is about Files.app as an app, not about the
     // dialog mode itself. It can also lead to hard-to-fix bug crbug.com/339089.
     var hideHelp = DialogType.isModal(fileManager.dialogType);
     event.canExecute = !hideHelp;
     event.command.setHidden(hideHelp);
     fileManager.document_.getElementById('help-separator').hidden = hideHelp;
   }
 });
 
 /**
  * Opens drive buy-more-space url.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['drive-buy-more-space'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     util.visitURL(str('GOOGLE_DRIVE_BUY_STORAGE_URL'));
   },
   canExecute: CommandUtil.canExecuteVisibleOnDriveInNormalAppModeOnly
 });
 
 /**
  * Opens drive.google.com.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['drive-go-to-drive'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     util.visitURL(str('GOOGLE_DRIVE_ROOT_URL'));
   },
   canExecute: CommandUtil.canExecuteVisibleOnDriveInNormalAppModeOnly
 });
 
 /**
  * Displays open with dialog for current selection.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['open-with'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     var tasks = fileManager.getSelection().tasks;
     if (tasks) {
       tasks.showTaskPicker(fileManager.defaultTaskPicker,
           str('OPEN_WITH_BUTTON_LABEL'),
           '',
           function(task) {
             tasks.execute(task.taskId);
           });
     }
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var tasks = fileManager.getSelection().tasks;
     event.canExecute = tasks && tasks.size() > 1;
   }
 });
 
 /**
  * Focuses search input box.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['search'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     var element = fileManager.document.querySelector('#search-box input');
     element.focus();
     element.select();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     event.canExecute = !fileManager.isRenamingInProgress();
   }
 });
 
 /**
  * Activates the n-th volume.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['volume-switch-1'] =
@@ skipping 74 matching lines @@
       }
     };
     steps.start();
 
     var driveSyncHandler =
         fileManager.backgroundPage.background.driveSyncHandler;
     if (pin && driveSyncHandler.isSyncSuppressed())
       driveSyncHandler.showDisabledMobileSyncNotification();
   },
 
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var entries = CommandUtil.getPinTargetEntries();
     var checked = true;
     for (var i = 0; i < entries.length; i++) {
       checked = checked && entries[i].pinned;
     }
     if (entries.length > 0) {
       event.canExecute = true;
       event.command.setHidden(false);
       event.command.checked = checked;
     } else {
       event.canExecute = false;
       event.command.setHidden(true);
     }
   }
 });
 
 /**
  * Creates zip file for current selection.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['zip-selection'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     var dirEntry = fileManager.getCurrentDirectoryEntry();
+    if (!dirEntry)
+      return;
     var selectionEntries = fileManager.getSelection().entries;
-    fileManager.fileOperationManager_.zipSelection(dirEntry, selectionEntries);
+    fileManager.fileOperationManager_.zipSelection(
+        dirEntry, selectionEntries);
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var dirEntry = fileManager.getCurrentDirectoryEntry();
     var selection = fileManager.getSelection();
     event.canExecute =
         dirEntry &&
         !fileManager.isOnReadonlyDirectory() &&
         !fileManager.isOnDrive() &&
         selection && selection.totalCount > 0;
   }
 });
 
 /**
  * Shows the share dialog for the current selection (single only).
  * @type {Command}
  */
 CommandHandler.COMMANDS_['share'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     fileManager.shareSelection();
   },
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   canExecute: function(event, fileManager) {
     var selection = fileManager.getSelection();
     var isDriveOffline =
         fileManager.volumeManager.getDriveConnectionState().type ===
             VolumeManagerCommon.DriveConnectionType.OFFLINE;
     event.canExecute = fileManager.isOnDrive() &&
         !isDriveOffline &&
         selection && selection.totalCount == 1;
     event.command.setHidden(!fileManager.isOnDrive());
   }
@@ skipping 75 matching lines @@
     event.canExecute = isShortcut && eligible;
     event.command.setHidden(!event.canExecute);
   }
 });
 
 /**
  * Zoom in to the Files.app.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['zoom-in'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.zoom('in');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Zoom out from the Files.app.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['zoom-out'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.zoom('out');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Reset the zoom factor.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['zoom-reset'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.zoom('reset');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Open inspector for foreground page.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['inspect-normal'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.openInspector('normal');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Open inspector for foreground page and bring focus to the console.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['inspect-console'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.openInspector('console');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Open inspector for foreground page in inspect element mode.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['inspect-element'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.openInspector('element');
   },
   canExecute: CommandUtil.canExecuteAlways
 });
 
 /**
  * Open inspector for background page.
  * @type {Command}
  */
 CommandHandler.COMMANDS_['inspect-background'] = /** @type {Command} */ ({
+  /**
+   * @param {Event} event Command event.
+   * @param {FileManager} fileManager FileManager to use.
+   */
   execute: function(event, fileManager) {
     chrome.fileManagerPrivate.openInspector('background');
   },
   canExecute: CommandUtil.canExecuteAlways
 });