JavaScript style fixups in feedback.js

chrome/browser/resources/feedback.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.
 
 // Constants.
 /** @const */ var FEEDBACK_LANDING_PAGE =
     'http://www.google.com/support/chrome/go/feedback_confirmation';
 
 var selectedThumbnailDivId = '';
 var selectedThumbnailId = '';
 var selectedImageUrl;
 
 var savedThumbnailIds = [];
 savedThumbnailIds['current-screenshots'] = '';
 savedThumbnailIds['saved-screenshots'] = '';
 
 var categoryTag = '';
 
 var localStrings = new LocalStrings();
 
 /**
  * Selects an image thumbnail in the specified div.
+ * @param {string} divId The id of the div to search in.
+ * @param {string} thumbnailId The id of the thumbnail to search for.
  */
 function selectImage(divId, thumbnailId) {
   var thumbnailDivs = $(divId).children;
   selectedThumbnailDivId = divId;
   if (thumbnailDivs.length == 0) {
     $(divId).hidden = true;
     return;
   }
   for (var i = 0; i < thumbnailDivs.length; i++) {
     // If the the current div matches the thumbnail id provided,
     // or there is no thumbnail id given, and we're at the first thumbnail.
     if ((thumbnailDivs[i].id == thumbnailId) || (!thumbnailId && !i)) {
       thumbnailDivs[i].className = 'image-thumbnail-container-selected';
       selectedThumbnailId = thumbnailId;
       savedThumbnailIds[divId] = thumbnailId;
     } else {
       thumbnailDivs[i].className = 'image-thumbnail-container';
     }
   }
 }
 
 /**
  * Adds an image thumbnail to the specified div.
+ * @param {string} divId The id of the div to add a screenshot to.
+ * @param {string} screenshot The URL of the screenshot being added.
  */
 function addScreenshot(divId, screenshot) {
   var thumbnailDiv = document.createElement('div');
   thumbnailDiv.className = 'image-thumbnail-container';
 
   thumbnailDiv.id = divId + '-thumbnailDiv-' + $(divId).children.length;
   thumbnailDiv.onclick = function() {
     selectImage(divId, thumbnailDiv.id);
   };
 
@@ skipping 23 matching lines @@
 function disableScreenshots() {
   $('screenshot-row').hidden = true;
   $('screenshot-checkbox').checked = false;
 
   $('current-screenshots').hidden = true;
   if ($('saved-screenshots'))
     $('saved-screenshots').hidden = true;
 }
 
 /**
- * Send's the report; after the report is sent, we need to be redirected to
+ * Sends the report; after the report is sent, we need to be redirected to
  * the landing page, but we shouldn't be able to navigate back, hence
  * we open the landing page in a new tab and sendReport closes this tab.
+ * @return {boolean} True if the report was sent.
  */
 function sendReport() {
   if ($('description-text').value.length == 0) {
     alert(localStrings.getString('no-description'));
     return false;
   }
 
   var imagePath = '';
   if ($('screenshot-checkbox').checked && selectedThumbnailId)
     imagePath = $(selectedThumbnailId + '-image').src;
@@ skipping 14 matching lines @@
     reportArray = reportArray.concat([userEmail,
                                       String($('sys-info-checkbox').checked)]);
   }
 
   // open the landing page in a new tab, sendReport will close this one.
   window.open(FEEDBACK_LANDING_PAGE, '_blank');
   chrome.send('sendReport', reportArray);
   return true;
 }
 
+/**
+ * Click listener for the cancel button.
+ * @return {boolean} true

[Dan Beam, 2012/04/27 03:28:46]

remove this and change to take |e| param and call e.preventDefault() IMO

+ */
 function cancel() {
   chrome.send('cancel');
   return true;
 }
 
 /**
  * Select the current screenshots div, restoring the image that was
  * selected when we had this div open previously.
  */
 function currentSelected() {
   // TODO(rkc): Change this to use a class instead.
   $('current-screenshots').hidden = false;
   if ($('saved-screenshots'))
     $('saved-screenshots').hidden = true;
 
   if (selectedThumbnailDivId != 'current-screenshots')
     selectImage('current-screenshots',
                 savedThumbnailIds['current-screenshots']);
-
-  return true;
 }
 
 /**
  * Select the saved screenshots div, restoring the image that was
  * selected when we had this div open previously.
  */
 function savedSelected() {
   $('current-screenshots').hidden = true;
 
   if ($('saved-screenshots').childElementCount == 0) {
     // setupSavedScreenshots will take care of changing visibility
     chrome.send('refreshSavedScreenshots');
   } else {
     $('saved-screenshots').hidden = false;
     if (selectedThumbnailDivId != 'saved-screenshots')
       selectImage('saved-screenshots', savedThumbnailIds['saved-screenshots']);
   }
-
-  return true;
 }
 
 
 /**
  * Change the type of screenshot we're showing to the user from
  * the current screenshot to saved screenshots
  */
 function changeToSaved() {
   $('screenshot-label-current').hidden = true;
   $('screenshot-label-saved').hidden = false;
@@ skipping 122 matching lines @@
         $('user-email-table').hidden = true;
 
         // this also means we are in privacy mode, so no saved screenshots.
         $('screenshot-link-tosaved').hidden = true;
       }
     }
   }
 }
 
 window.addEventListener('DOMContentLoaded', load);