Fix typedef for InternetDetailedInfo in internet_detail.js

chrome/browser/resources/options/chromeos/internet_detail.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.
 
 // require: onc_data.js
 
 // NOTE(stevenjb): This code is in the process of being converted to be
 // compatible with the networkingPrivate extension API:
 // * The network property dictionaries are being converted to use ONC values.
 // * chrome.send calls will be replaced with an API object that simulates the
 //   networkingPrivate API. See network_config.js.
 // See crbug.com/279351 for more info.
 
-/** @typedef {{activationState: (string|undefined),
- *             carriers: Array,
- *             currentCarrierIndex; (number|undefined),
- *             ipAutoConfig: boolean,
- *             ipconfig: Object,
- *             nameServerType: string,
- *             restrictedPool: (string|undefined),
- *             roamingState: (string|undefined),
- *             savedIP: Object,
- *             showActivateButton: (boolean|undefined)
- *             showViewAccountButton: (boolean|undefined),
- *             staticIP: Object}}
- * Only the keys which had caused problems are declared in this typedef.
- * There are many more of them.
+/**
+ * InternetDetailedInfo argument passed to showDetailedInfo.
  * @see chrome/browser/ui/webui/options/chromeos/internet_options_handler.cc
+ * @typedef {{
+ *   carriers: boolean,

[Vitaly Pavlenko, 2014/09/15 19:18:08]

As it's being put in a dictionary only on some execution path (is it?), it
should be 

 *   carriers: (boolean|undefined),

[stevenjb, 2014/09/15 19:52:35]

It actually should be (Array.<string>|undefined), I did this too quickly.

+ *   currentCarrierIndex: boolean,
+ *   deviceConnected: boolean,
+ *   errorMessage: string,
+ *   servicePath: boolean,
+ *   showCarrierSelect: boolean,
+ *   showViewAccountButton: boolean

[Vitaly Pavlenko, 2014/09/15 19:18:08]

^ same here: (boolean|undefined)

[stevenjb, 2014/09/15 19:52:35]

Fixed this and other errors.

+ * }}
  */
 var InternetDetailedInfo;
 
 cr.define('options.internet', function() {
   var OncData = cr.onc.OncData;
   var Page = cr.ui.pageManager.Page;
   var PageManager = cr.ui.pageManager.PageManager;
   /** @const */ var IPAddressField = options.internet.IPAddressField;
 
   /** @const */ var GoogleNameServersString = '8.8.4.4,8.8.8.8';
@@ skipping 55 matching lines @@
    * @param {string} message The message to send to chrome.
    * @param {HTMLInputElement} checkbox The checkbox storing the value to send.
    */
   function sendCheckedIfEnabled(path, message, checkbox) {
     if (!checkbox.hidden && !checkbox.disabled)
       chrome.send(message, [path, checkbox.checked ? 'true' : 'false']);
   }
 
   /**
    * Returns the netmask as a string for a given prefix length.
-   * @param {string} prefixLength The ONC routing prefix length.
+   * @param {number} prefixLength The ONC routing prefix length.
    * @return {string} The corresponding netmask.
    */
   function prefixLengthToNetmask(prefixLength) {
     // Return the empty string for invalid inputs.
     if (prefixLength < 0 || prefixLength > 32)
       return '';
     var netmask = '';
     for (var i = 0; i < 4; ++i) {
       var remainder = 8;
       if (prefixLength >= 8) {
@@ skipping 454 matching lines @@
       $('socks-host').disabled = allDisabled;
       $('socks-port').disabled = allDisabled;
       $('proxy-use-pac-url').disabled = true;
       $('proxy-pac-url').disabled = true;
       $('auto-proxy-parms').hidden = !$('auto-proxy').checked;
       $('manual-proxy-parms').hidden = !$('manual-proxy').checked;
       chrome.send('coreOptionsUserMetricsAction',
                   ['Options_NetworkManualProxy_Enable']);
     },
 
+    /**
+     * Helper method called from showDetailedInfo and updateConnectionData.
+     * Updates visibilty/enabled of the login/disconnect/configure buttons.
+     * @private
+     */
     updateConnectionButtonVisibilty_: function() {
       var onc = this.onc_;
       if (this.type_ == 'Ethernet') {
         // Ethernet can never be connected or disconnected and can always be
         // configured (e.g. to set security).
         $('details-internet-login').hidden = true;
         $('details-internet-disconnect').hidden = true;
         $('details-internet-configure').hidden = false;
         return;
       }
@@ skipping 14 matching lines @@
       var connectable = onc.getActiveValue('Connectable');
       if (connectState != 'Connected' &&
           (!connectable || onc.getWiFiSecurity() != 'None' ||
           (this.type_ == 'Wimax' || this.type_ == 'VPN'))) {
         $('details-internet-configure').hidden = false;
       } else {
         $('details-internet-configure').hidden = true;
       }
     },
 
+    /**
+     * Helper method called from showDetailedInfo and updateConnectionData.
+     * Updates the connection state property and account / sim card links.
+     * @param {InternetDetailedInfo} data
+     * @private
+     */
     updateDetails_: function(data) {
       var onc = this.onc_;
 
       if ('deviceConnected' in data)
         this.deviceConnected_ = data.deviceConnected;
 
       var connectionStateString = onc.getTranslatedValue('ConnectionState');
       $('connection-state').textContent = connectionStateString;
 
       var type = this.type_;
@@ skipping 18 matching lines @@
             activationState == 'PartiallyActivated';
       }
 
       $('view-account-details').hidden = !showViewAccount;
       $('activate-details').hidden = !showActivate;
       // If activation is not complete, hide the login button.
       if (showActivate)
         $('details-internet-login').hidden = true;
     },
 
+    /**
+     * Helper method called from showDetailedInfo and updateConnectionData.
+     * Updates the fields in the header section of the details frame.
+     * @private
+     */
     populateHeader_: function() {
       var onc = this.onc_;
 
       $('network-details-title').textContent = onc.getTranslatedValue('Name');
       var connectionState = onc.getActiveValue('ConnectionState');
       var connectionStateString = onc.getTranslatedValue('ConnectionState');
       $('network-details-subtitle-status').textContent = connectionStateString;
 
       var typeKey;
       var type = this.type_;
@@ skipping 14 matching lines @@
       if (typeKey) {
         typeLabel.textContent = loadTimeData.getString(typeKey);
         typeLabel.hidden = false;
         typeSeparator.hidden = false;
       } else {
         typeLabel.hidden = true;
         typeSeparator.hidden = true;
       }
     },
 
-    initializeApnList_: function(onc) {
+    /**
+     * Helper method called from showDetailedInfo to intialize the Apn list.
+     * @private
+     */
+    initializeApnList_: function() {
+      var onc = this.onc_;
+
       var apnSelector = $('select-apn');
       // Clear APN lists, keep only last element that "other".
       while (apnSelector.length != 1) {
         apnSelector.remove(0);
       }
       var otherOption = apnSelector[0];
       var activeApn = onc.getActiveValue('Cellular.APN.AccessPointName');
       var activeUsername = onc.getActiveValue('Cellular.APN.Username');
       var activePassword = onc.getActiveValue('Cellular.APN.Password');
       var lastGoodApn =
@@ skipping 33 matching lines @@
         apnSelector.add(activeOption, otherOption);
         this.selectedApnIndex_ = apnSelector.length - 2;
         this.userApnIndex_ = this.selectedApnIndex_;
       }
       assert(this.selectedApnIndex_ >= 0);
       apnSelector.selectedIndex = this.selectedApnIndex_;
       updateHidden('.apn-list-view', false);
       updateHidden('.apn-details-view', true);
     },
 
+    /**
+     * Event Listener for the cellular-apn-use-default button.
+     * @private
+     */
     setDefaultApn_: function() {
       var onc = this.onc_;
       var apnSelector = $('select-apn');
 
       if (this.userApnIndex_ != -1) {
         apnSelector.remove(this.userApnIndex_);
         this.userApnIndex_ = -1;
       }
 
       var iApn = -1;
@@ skipping 12 matching lines @@
                                activeApn['Username'],
                                activeApn['Password']]);
       }
       apnSelector.selectedIndex = iApn;
       this.selectedApnIndex_ = iApn;
 
       updateHidden('.apn-list-view', false);
       updateHidden('.apn-details-view', true);
     },
 
+    /**
+     * Event Listener for the cellular-apn-set button.
+     * @private
+     */
     setApn_: function(apnValue) {
       if (apnValue == '')
         return;
 
       var onc = this.onc_;
       var apnSelector = $('select-apn');
 
       var activeApn = {};
       activeApn['AccessPointName'] = stringFromValue(apnValue);
       activeApn['Username'] = stringFromValue($('cellular-apn-username').value);
@@ skipping 15 matching lines @@
       option.value = -1;
       option.selected = true;
       apnSelector.add(option, apnSelector[apnSelector.length - 1]);
       this.userApnIndex_ = apnSelector.length - 2;
       this.selectedApnIndex_ = this.userApnIndex_;
 
       updateHidden('.apn-list-view', false);
       updateHidden('.apn-details-view', true);
     },
 
+    /**
+     * Event Listener for the cellular-apn-cancel button.
+     * @private
+     */
     cancelApn_: function() {
       $('select-apn').selectedIndex = this.selectedApnIndex_;
       updateHidden('.apn-list-view', false);
       updateHidden('.apn-details-view', true);
     },
 
+    /**
+     * Event Listener for the select-apn button.
+     * @private
+     */
     selectApn_: function() {
       var onc = this.onc_;
       var apnSelector = $('select-apn');
       var apnDict;
       if (apnSelector[apnSelector.selectedIndex].value != -1) {
         var apnList = onc.getActiveValue('Cellular.APNList');
         var apnIndex = apnSelector.selectedIndex;
         assert(apnIndex < apnList.length);
         apnDict = apnList[apnIndex];
         chrome.send('setApn', [this.servicePath_,
@@ skipping 548 matching lines @@
       // Show IMEI/ESN/MEID/MIN/PRL only if they are available.
       setOrHideParent('esn', onc.getActiveValue('Cellular.ESN'));
       setOrHideParent('imei', onc.getActiveValue('Cellular.IMEI'));
       setOrHideParent('meid', onc.getActiveValue('Cellular.MEID'));
       setOrHideParent('min', onc.getActiveValue('Cellular.MIN'));
       setOrHideParent('prl-version', onc.getActiveValue('Cellular.PRLVersion'));
 
       if (onc.getActiveValue('Cellular.Family') == 'GSM') {
         $('iccid').textContent = onc.getActiveValue('Cellular.ICCID');
         $('imsi').textContent = onc.getActiveValue('Cellular.IMSI');
-        detailsPage.initializeApnList_(onc);
+        detailsPage.initializeApnList_();
       }
       $('auto-connect-network-cellular').checked =
           onc.getActiveValue('AutoConnect');
       $('auto-connect-network-cellular').disabled = false;
     } else if (type == 'VPN') {
       OptionsPage.showTab($('vpn-nav-tab'));
       $('inet-service-name').textContent = networkName;
       $('inet-provider-type').textContent =
           onc.getTranslatedValue('VPN.Type');
       var providerType = onc.getActiveValue('VPN.Type');
@@ skipping 48 matching lines @@
 
     // Don't show page name in address bar and in history to prevent people
     // navigate here by hand and solve issue with page session restore.
     PageManager.showPageByName('detailsInternetPage', false);
   };
 
   return {
     DetailsInternetPage: DetailsInternetPage
   };
 });