DevTools: add more jsdocs to NetworkPanel.

Source/devtools/front_end/network/NetworkPanel.js

 /*
  * Copyright (C) 2007, 2008 Apple Inc.  All rights reserved.
  * Copyright (C) 2008, 2009 Anthony Ricaud <rik@webkit.org>
  * Copyright (C) 2011 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
@@ skipping 165 matching lines @@
         this._dataURLFilterUI.addEventListener(WebInspector.FilterUI.Events.FilterChanged, this._filterChanged.bind(this), this);
         this._filterBar.addFilter(this._dataURLFilterUI);
     },
 
     _resetSuggestionBuilder: function()
     {
         this._suggestionBuilder = new WebInspector.FilterSuggestionBuilder(WebInspector.NetworkPanel._searchKeys);
         this._textFilterUI.setSuggestionBuilder(this._suggestionBuilder);
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _filterChanged: function(event)
     {
         this._removeAllNodeHighlights();
         this.searchCanceled();
         this._parseFilterQuery(this._textFilterUI.value());
         this._filterRequests();
     },
 
     _initializeView: function()
     {
@@ skipping 183 matching lines @@
         this._dataGrid.element.addEventListener("contextmenu", this._contextMenu.bind(this), true);
         this._dataGrid.show(this.element);
 
         // Event listeners need to be added _after_ we attach to the document, so that owner document is properly update.
         this._dataGrid.addEventListener(WebInspector.DataGrid.Events.SortingChanged, this._sortItems, this);
         this._dataGrid.addEventListener(WebInspector.DataGrid.Events.ColumnsResized, this._updateDividersIfNeeded, this);
 
         this._patchTimelineHeader();
     },
 
+    /**
+     * @param {string} title
+     * @param {string} subtitle
+     * @return {!DocumentFragment}
+     */
     _makeHeaderFragment: function(title, subtitle)
     {
         var fragment = document.createDocumentFragment();
         fragment.createTextChild(title);
         var subtitleDiv = fragment.createChild("div", "network-header-subtitle");
         subtitleDiv.createTextChild(subtitle);
         return fragment;
     },
 
     _patchTimelineHeader: function()
@@ skipping 302 matching lines @@
         this._largerRequestsButton.addEventListener("click", this._toggleLargerRequests, this);
 
         this._preserveLogCheckbox = new WebInspector.StatusBarCheckbox(WebInspector.UIString("Preserve log"));
         this._preserveLogCheckbox.element.title = WebInspector.UIString("Do not clear log on page reload / navigation.");
 
         this._disableCacheCheckbox = new WebInspector.StatusBarCheckbox(WebInspector.UIString("Disable cache"));
         WebInspector.SettingsUI.bindCheckbox(this._disableCacheCheckbox.inputElement, WebInspector.settings.cacheDisabled);
         this._disableCacheCheckbox.element.title = WebInspector.UIString("Disable cache (while DevTools is open).");
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _loadEventFired: function(event)
     {
         if (!this._recordButton.toggled)
             return;
 
         this._mainRequestLoadTime = event.data || -1;
         // Schedule refresh to update boundaries and draw the new line.
         this._scheduleRefresh();
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _domContentLoadedEventFired: function(event)
     {
         if (!this._recordButton.toggled)
             return;
         this._mainRequestDOMContentLoadedTime = event.data || -1;
         // Schedule refresh to update boundaries and draw the new line.
         this._scheduleRefresh();
     },
 
     wasShown: function()
@@ skipping 84 matching lines @@
         if (this._dataGrid) {
             this._dataGrid.rootNode().removeChildren();
             this._updateDividersIfNeeded();
             this._updateSummaryBar();
         }
 
         this._mainRequestLoadTime = -1;
         this._mainRequestDOMContentLoadedTime = -1;
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _onRequestStarted: function(event)
     {
-        if (this._recordButton.toggled)
-            this._appendRequest(event.data);
+        if (this._recordButton.toggled) {
+            var request = /** @type {!WebInspector.NetworkRequest} */ (event.data);
+            this._appendRequest(request);
+        }
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _appendRequest: function(request)
     {
         this._requests.push(request);
 
         // In case of redirect request id is reassigned to a redirected
         // request and we need to update _requestsById and search results.
         if (this._requestsById[request.requestId]) {
             var oldRequest = request.redirects[request.redirects.length - 1];
             this._requestsById[oldRequest.requestId] = oldRequest;
 
@@ skipping 40 matching lines @@
             var cookie = cookies[i];
             this._suggestionBuilder.addItem(WebInspector.NetworkPanel.FilterType.SetCookieDomain, cookie.domain());
             this._suggestionBuilder.addItem(WebInspector.NetworkPanel.FilterType.SetCookieName, cookie.name());
             this._suggestionBuilder.addItem(WebInspector.NetworkPanel.FilterType.SetCookieValue, cookie.value());
         }
 
         this._staleRequests[request.requestId] = request;
         this._scheduleRefresh();
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _willReloadPage: function(event)
     {
         this._recordButton.toggled = true;
         if (!this._preserveLogCheckbox.checked())
             this._reset();
     },
 
     /**
      * @param {!WebInspector.Event} event
      */
@@ skipping 40 matching lines @@
         this._updateColumns();
         this._popoverHelper.hidePopover();
     },
 
     _toggleLargerRequests: function()
     {
         WebInspector.settings.resourcesLargeRows.set(!WebInspector.settings.resourcesLargeRows.get());
         this._setLargerRequests(WebInspector.settings.resourcesLargeRows.get());
     },
 
+    /**
+     * @param {boolean} enabled
+     */
     _setLargerRequests: function(enabled)
     {
         this._largerRequestsButton.toggled = enabled;
         if (!enabled) {
             this._largerRequestsButton.title = WebInspector.UIString("Use large resource rows.");
             this._dataGrid.element.classList.add("small");
             this._timelineGrid.element.classList.add("small");
         } else {
             this._largerRequestsButton.title = WebInspector.UIString("Use small resource rows.");
             this._dataGrid.element.classList.remove("small");
             this._timelineGrid.element.classList.remove("small");
         }
         this.dispatchEventToListeners(WebInspector.NetworkLogView.EventTypes.RowSizeChanged, { largeRows: enabled });
     },
 
-    _getPopoverAnchor: function(element)
+    /**
+     * @param {!Element} element
+     * @param {!Event} event
+     * @return {!Element|!AnchorBox|undefined}
+     */
+    _getPopoverAnchor: function(element, event)
     {
         if (!this._allowPopover)
             return;
         var anchor = element.enclosingNodeOrSelfWithClass("network-graph-bar") || element.enclosingNodeOrSelfWithClass("network-graph-label");
         if (anchor && anchor.parentElement.request && anchor.parentElement.request.timing)
             return anchor;
         anchor = element.enclosingNodeOrSelfWithClass("network-script-initiated");
         if (anchor && anchor.request && anchor.request.initiator)
             return anchor;
-
-        return null;
     },
 
     /**
      * @param {!Element} anchor
      * @param {!WebInspector.Popover} popover
      */
     _showPopover: function(anchor, popover)
     {
         var content;
         if (anchor.classList.contains("network-script-initiated"))
@@ skipping 65 matching lines @@
         function compare(id1, id2)
         {
             return columnTitles[id1].compareTo(columnTitles[id2]);
         }
 
         var columnIDs = Object.keys(this._coulmnsVisibilitySetting.get());
         this._configurableColumnIDs = columnIDs.sort(compare);
         return this._configurableColumnIDs;
     },
 
+    /**
+     * @param {?Event} event
+     */
     _contextMenu: function(event)
     {
         var contextMenu = new WebInspector.ContextMenu(event);
 
         if (this._detailedMode && event.target.isSelfOrDescendant(this._dataGrid.headerTableBody)) {
             var columnsVisibility = this._coulmnsVisibilitySetting.get();
             var columnIDs = this._getConfigurableColumnIDs();
             var columnTitles = WebInspector.NetworkLogView._columnTitles;
             for (var i = 0; i < columnIDs.length; ++i) {
                 var columnIdentifier = columnIDs[i];
@@ skipping 37 matching lines @@
 
         if (request && request.type === WebInspector.resourceTypes.XHR) {
             contextMenu.appendSeparator();
             contextMenu.appendItem(WebInspector.UIString("Replay XHR"), this._replayXHR.bind(this, request.requestId));
             contextMenu.appendSeparator();
         }
 
         contextMenu.show();
     },
 
+    /**
+     * @param {string} requestId
+     */
     _replayXHR: function(requestId)
     {
         NetworkAgent.replayXHR(requestId);
     },
 
     _harRequests: function()
     {
         var httpRequests = this._requests.filter(WebInspector.NetworkLogView.HTTPRequestsFilter);
         httpRequests = httpRequests.filter(WebInspector.NetworkLogView.FinishedRequestsFilter);
         return httpRequests.filter(WebInspector.NetworkLogView.NonDevToolsRequestsFilter);
     },
 
     _copyAll: function()
     {
         var harArchive = {
             log: (new WebInspector.HARLog(this._harRequests())).build()
         };
         InspectorFrontendHost.copyText(JSON.stringify(harArchive, null, 2));
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _copyLocation: function(request)
     {
         InspectorFrontendHost.copyText(request.url);
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _copyRequestHeaders: function(request)
     {
         InspectorFrontendHost.copyText(request.requestHeadersText());
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _copyResponse: function(request)
     {
+        /**
+         * @param {?string} content
+         */
         function callback(content)
         {
             if (request.contentEncoded)
                 content = request.asDataURL();
             InspectorFrontendHost.copyText(content || "");
         }
         request.requestContent(callback);
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _copyResponseHeaders: function(request)
     {
         InspectorFrontendHost.copyText(request.responseHeadersText);
     },
 
     /**
      * @param {!WebInspector.NetworkRequest} request
      */
     _copyCurlCommand: function(request)
     {
@@ skipping 26 matching lines @@
         if (confirm(WebInspector.UIString("Are you sure you want to clear browser cache?")))
             NetworkAgent.clearBrowserCache();
     },
 
     _clearBrowserCookies: function()
     {
         if (confirm(WebInspector.UIString("Are you sure you want to clear browser cookies?")))
             NetworkAgent.clearBrowserCookies();
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     * @return {number}
+     */
     _matchRequest: function(request)
     {
         if (!this._searchRegExp)
             return -1;
 
         if (!request.name().match(this._searchRegExp) && !request.path().match(this._searchRegExp))
             return -1;
 
         if (request.requestId in this._matchedRequestsMap)
             return this._matchedRequestsMap[request.requestId];
@@ skipping 16 matching lines @@
     _updateSearchMatchedListAfterRequestIdChanged: function(oldRequestId, newRequestId)
     {
         var requestIndex = this._matchedRequestsMap[oldRequestId];
         if (requestIndex) {
             delete this._matchedRequestsMap[oldRequestId];
             this._matchedRequestsMap[newRequestId] = requestIndex;
             this._matchedRequests[requestIndex] = newRequestId;
         }
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _updateHighlightIfMatched: function(request)
     {
         var matchedRequestIndex = this._matchRequest(request);
         if (matchedRequestIndex === -1)
             return;
 
         this.dispatchEventToListeners(WebInspector.NetworkLogView.EventTypes.SearchCountUpdated, this._matchedRequests.length);
 
         if (this._currentMatchedRequestIndex !== -1 && this._currentMatchedRequestIndex !== matchedRequestIndex)
             return;
@@ skipping 78 matching lines @@
             }
         }
 
         this.dispatchEventToListeners(WebInspector.NetworkLogView.EventTypes.SearchCountUpdated, this._matchedRequests.length);
         if (shouldJump) {
             var index = this._normalizeSearchResultIndex(newMatchedRequestIndex);
             this._highlightNthMatchedRequestForSearch(index, true);
         }
     },
 
+    /**
+     * @param {number} index
+     * @return {number}
+     */
     _normalizeSearchResultIndex: function(index)
     {
         return (index + this._matchedRequests.length) % this._matchedRequests.length;
     },
 
     /**
      * @param {!WebInspector.NetworkDataGridNode} node
      */
     _applyFilter: function(node)
     {
@@ skipping 94 matching lines @@
         var index = this._normalizeSearchResultIndex(this._currentMatchedRequestIndex + 1);
         this._highlightNthMatchedRequestForSearch(index, true);
     },
 
     searchCanceled: function()
     {
         this._clearSearchMatchedList();
         this.dispatchEventToListeners(WebInspector.NetworkLogView.EventTypes.SearchCountUpdated, 0);
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     revealAndHighlightRequest: function(request)
     {
         this._removeAllNodeHighlights();
 
         var node = this._requestGridNode(request);
         if (node) {
             this._dataGrid.element.focus();
             node.reveal();
             this._highlightNode(node);
         }
     },
 
     _removeAllNodeHighlights: function()
     {
         if (this._highlightedNode) {
             this._highlightedNode.element.classList.remove("highlighted-row");
             delete this._highlightedNode;
         }
     },
 
+    /**
+     * @param {!WebInspector.NetworkDataGridNode} node
+     */
     _highlightNode: function(node)
     {
         WebInspector.runCSSAnimationOnce(node.element, "highlighted-row");
         this._highlightedNode = node;
     },
 
-   /**
+    /**
      * @param {!WebInspector.NetworkRequest} request
      * @return {string}
      */
     _generateCurlCommand: function(request)
     {
         var command = ["curl"];
         // These headers are derived from URL (except "version") and would be added by cURL anyway.
         var ignoredHeaders = {"host": 1, "method": 1, "path": 1, "scheme": 1, "version": 1};
 
         function escapeStringWin(str)
@@ skipping 309 matching lines @@
     SetCookieDomain: "SetCookieDomain",
     SetCookieName: "SetCookieName",
     SetCookieValue: "SetCookieValue",
     StatusCode: "StatusCode"
 };
 
 /** @type {!Array.<string>} */
 WebInspector.NetworkPanel._searchKeys = Object.values(WebInspector.NetworkPanel.FilterType);
 
 WebInspector.NetworkPanel.prototype = {
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _onFiltersToggled: function(event)
     {
         var toggled = /** @type {boolean} */ (event.data);
         this._filtersContainer.classList.toggle("hidden", !toggled);
         this.element.classList.toggle("filters-toggled", toggled);
         this.doResize();
     },
 
     /**
      * @return {!Array.<!Element>}
@@ skipping 10 matching lines @@
     {
         return this._searchableView;
     },
 
     // FIXME: only used by the layout tests, should not be exposed.
     _reset: function()
     {
         this._networkLogView._reset();
     },
 
+    /**
+     * @param {!KeyboardEvent} event
+     */
     handleShortcut: function(event)
     {
         if (this._viewingRequestMode && event.keyCode === WebInspector.KeyboardShortcut.Keys.Esc.code) {
             this._toggleGridMode();
             event.handled = true;
             return;
         }
 
         WebInspector.Panel.prototype.handleShortcut.call(this, event);
     },
 
     wasShown: function()
     {
         WebInspector.Panel.prototype.wasShown.call(this);
     },
 
     /**
      * @param {!WebInspector.NetworkRequest} request
      */
     revealAndHighlightRequest: function(request)
     {
         this._toggleGridMode();
         if (request)
             this._networkLogView.revealAndHighlightRequest(request);
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _onViewCleared: function(event)
     {
         this._closeVisibleRequest();
         this._toggleGridMode();
         this._viewsContainerElement.removeChildren();
         this._viewsContainerElement.appendChild(this._closeButtonElement);
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _onRowSizeChanged: function(event)
     {
         this._viewsContainerElement.classList.toggle("small", !event.data.largeRows);
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
     _onSearchCountUpdated: function(event)
     {
-        this._searchableView.updateSearchMatchesCount(event.data);
-    },
-
-    _onSearchIndexUpdated: function(event)
-    {
-        this._searchableView.updateCurrentMatchIndex(event.data);
-    },
-
-    _onRequestSelected: function(event)
-    {
-        this._showRequest(event.data);
+        var count = /** @type {number} */ (event.data);
+        this._searchableView.updateSearchMatchesCount(count);
     },
 
     /**
+     * @param {!WebInspector.Event} event
+     */
+    _onSearchIndexUpdated: function(event)
+    {
+        var index = /** @type {number} */ (event.data);
+        this._searchableView.updateCurrentMatchIndex(index);
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onRequestSelected: function(event)
+    {
+        var request = /** @type {!WebInspector.NetworkRequest} */ (event.data);
+        this._showRequest(request);
+    },
+
+    /**
      * @param {?WebInspector.NetworkRequest} request
      */
     _showRequest: function(request)
     {
         if (!request)
             return;
 
         this._toggleViewingRequestMode();
 
         if (this._networkItemView) {
@@ skipping 280 matching lines @@
     /**
      * @param {number} value
      * @param {number=} precision
      * @return {string}
      */
     formatTime: function(value, precision)
     {
         return value.toString();
     },
 
+    /**
+     * @param {number} clientWidth
+     */
     setDisplayWindow: function(clientWidth)
     {
         this._workingArea = clientWidth;
     },
 
     /**
      * @return {number}
      */
     paddingLeft: function()
     {
@@ skipping 130 matching lines @@
     },
 
     /**
      * @return {string}
      */
     formatTime: function(value)
     {
         return Number.secondsToString(value);
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _lowerBound: function(request)
     {
         return 0;
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _upperBound: function(request)
     {
         return 0;
     },
 
     __proto__: WebInspector.NetworkBaseCalculator.prototype
 }
 
 /**
  * @constructor
  * @extends {WebInspector.NetworkTimeCalculator}
  */
 WebInspector.NetworkTransferTimeCalculator = function()
 {
     WebInspector.NetworkTimeCalculator.call(this, false);
 }
 
 WebInspector.NetworkTransferTimeCalculator.prototype = {
     /**
      * @param {number} value
      * @return {string}
      */
     formatTime: function(value)
     {
         return Number.secondsToString(value - this.zeroTime());
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _lowerBound: function(request)
     {
         return request.startTime;
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _upperBound: function(request)
     {
         return request.endTime;
     },
 
     __proto__: WebInspector.NetworkTimeCalculator.prototype
 }
 
 /**
  * @constructor
  * @extends {WebInspector.NetworkTimeCalculator}
  */
 WebInspector.NetworkTransferDurationCalculator = function()
 {
     WebInspector.NetworkTimeCalculator.call(this, true);
 }
 
 WebInspector.NetworkTransferDurationCalculator.prototype = {
     /**
      * @param {number} value
      * @return {string}
      */
     formatTime: function(value)
     {
         return Number.secondsToString(value);
     },
 
+    /**
+     * @param {!WebInspector.NetworkRequest} request
+     */
     _upperBound: function(request)
     {
         return request.duration;
     },
 
     __proto__: WebInspector.NetworkTimeCalculator.prototype
 }
 
 /**
  * @constructor
@@ skipping 90 matching lines @@
     {
         this._parentView.dispatchEventToListeners(WebInspector.NetworkLogView.EventTypes.RequestSelected, this._request);
         WebInspector.DataGridNode.prototype.select.apply(this, arguments);
 
         WebInspector.notifications.dispatchEventToListeners(WebInspector.UserMetrics.UserAction, {
             action: WebInspector.UserMetrics.UserActionNames.NetworkRequestSelected,
             url: this._request.url
         });
     },
 
+    /**
+     * @param {!RegExp=} regexp
+     */
     _highlightMatchedSubstring: function(regexp)
     {
         var domChanges = [];
         var matchInfo = this._element.textContent.match(regexp);
         if (matchInfo)
             WebInspector.highlightSearchResult(this._nameCell, matchInfo.index, matchInfo[0].length, domChanges);
         return domChanges;
     },
 
     _openInNewTab: function()
@@ skipping 184 matching lines @@
     {
         if (this._request.duration > 0) {
             cell.setTextAndTitle(Number.secondsToString(this._request.duration));
             this._appendSubtitle(cell, Number.secondsToString(this._request.latency));
         } else {
             cell.classList.add("network-dim-cell");
             cell.setTextAndTitle(WebInspector.UIString("Pending"));
         }
     },
 
+    /**
+     * @param {!Element} cellElement
+     * @param {string} subtitleText
+     */
     _appendSubtitle: function(cellElement, subtitleText)
     {
         var subtitleElement = document.createElement("div");
         subtitleElement.className = "network-cell-subtitle";
         subtitleElement.textContent = subtitleText;
         cellElement.appendChild(subtitleElement);
     },
 
+    /**
+     * @param {!WebInspector.NetworkBaseCalculator} calculator
+     */
     refreshGraph: function(calculator)
     {
         if (!this._timelineCell)
             return;
 
         var percentages = calculator.computeBarGraphPercentages(this._request);
         this._percentages = percentages;
 
         this._barAreaElement.classList.remove("hidden");
 
@@ skipping 203 matching lines @@
 WebInspector.NetworkDataGridNode.RequestPropertyComparator = function(propertyName, revert, a, b)
 {
     var aValue = a._request[propertyName];
     var bValue = b._request[propertyName];
     if (aValue > bValue)
         return revert ? -1 : 1;
     if (bValue > aValue)
         return revert ? 1 : -1;
     return a._request.indentityCompare(b._request);
 }