From b1f2b6cce674d20d9b84507c09a90e93fcbe107c Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Mon, 17 Feb 2020 13:00:16 +0000 Subject: [PATCH] Remove typedefs from {object_ui,network,layer_viewer,input,inline_editor}-legacy.js Bug: 1006759 Change-Id: I617f10f94b969a49a6d24bf00ba4f24409aa6211 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/2060293 Commit-Queue: Tim van der Lippe Reviewed-by: Paul Lewis --- front_end/inline_editor/BezierEditor.js | 7 ++- .../inline_editor/inline_editor-legacy.js | 3 -- front_end/input/InputModel.js | 29 ++++++++----- front_end/input/input-legacy.js | 7 --- front_end/layer_viewer/layer_viewer-legacy.js | 3 -- front_end/network/NetworkLogView.js | 15 ++++--- front_end/network/NetworkLogViewColumns.js | 43 ++++++++++++++----- front_end/network/NetworkWaterfallColumn.js | 24 +++++++---- front_end/network/RequestTimingView.js | 5 ++- front_end/network/network-legacy.js | 36 ---------------- front_end/object_ui/JavaScriptAutocomplete.js | 9 ++-- .../object_ui/ObjectPropertiesSection.js | 9 +++- front_end/object_ui/object_ui-legacy.js | 10 ----- 13 files changed, 98 insertions(+), 102 deletions(-) diff --git a/front_end/inline_editor/BezierEditor.js b/front_end/inline_editor/BezierEditor.js index 2346647647..41b0ef7e5b 100644 --- a/front_end/inline_editor/BezierEditor.js +++ b/front_end/inline_editor/BezierEditor.js @@ -153,7 +153,7 @@ export class BezierEditor extends UI.Widget.VBox { /** * @param {!Array<{name: string, value: string}>} presetGroup - * @return {!InlineEditor.BezierEditor.PresetCategory} + * @return {!PresetCategory} */ _createCategory(presetGroup) { const presetElement = createElementWithClass('div', 'bezier-preset-category'); @@ -188,7 +188,7 @@ export class BezierEditor extends UI.Widget.VBox { } /** - * @param {!InlineEditor.BezierEditor.PresetCategory} category + * @param {!PresetCategory} category * @param {!Event=} event */ _presetCategorySelected(category, event) { @@ -278,3 +278,6 @@ export const Presets = [ {name: 'Out ยท Back', value: 'cubic-bezier(0.18, 0.89, 0.32, 1.28)'} ] ]; + +/** @typedef {{presets: !Array.<{name: string, value: string}>, icon: !Element, presetIndex: number}} */ +export let PresetCategory; diff --git a/front_end/inline_editor/inline_editor-legacy.js b/front_end/inline_editor/inline_editor-legacy.js index d3e13cb4b6..d30b996b3e 100644 --- a/front_end/inline_editor/inline_editor-legacy.js +++ b/front_end/inline_editor/inline_editor-legacy.js @@ -40,6 +40,3 @@ InlineEditor.CSSShadowSwatch = InlineEditorModule.ColorSwatch.CSSShadowSwatch; /** @constructor */ InlineEditor.SwatchPopoverHelper = InlineEditorModule.SwatchPopoverHelper.SwatchPopoverHelper; - -/** @typedef {{presets: !Array.<{name: string, value: string}>, icon: !Element, presetIndex: number}} */ -InlineEditor.BezierEditor.PresetCategory; diff --git a/front_end/input/InputModel.js b/front_end/input/InputModel.js index 8acb732358..ed0ffb4c8e 100644 --- a/front_end/input/InputModel.js +++ b/front_end/input/InputModel.js @@ -13,7 +13,7 @@ export class InputModel extends SDK.SDKModel.SDKModel { this._inputAgent = target.inputAgent(); /** @type {?number} */ this._eventDispatchTimer = null; - /** @type {!Array}*/ + /** @type {!Array}*/ this._dispatchEventDataList = []; /** @type {?function()} */ this._finishCallback = null; @@ -90,16 +90,16 @@ export class InputModel extends SDK.SDKModel.SDKModel { /** - * @param {!Input.InputModel.EventData} eventData + * @param {!EventData} eventData * @return {boolean} */ _isValidInputEvent(eventData) { - return this._isMouseEvent(/** @type {!Input.InputModel.MouseEventData} */ (eventData)) || - this._isKeyboardEvent(/** @type {!Input.InputModel.KeyboardEventData} */ (eventData)); + return this._isMouseEvent(/** @type {!MouseEventData} */ (eventData)) || + this._isKeyboardEvent(/** @type {!KeyboardEventData} */ (eventData)); } /** - * @param {!Input.InputModel.MouseEventData} eventData + * @param {!MouseEventData} eventData * @return {boolean} */ _isMouseEvent(eventData) { @@ -113,7 +113,7 @@ export class InputModel extends SDK.SDKModel.SDKModel { } /** - * @param {!Input.InputModel.KeyboardEventData} eventData + * @param {!KeyboardEventData} eventData * @return {boolean} */ _isKeyboardEvent(eventData) { @@ -130,9 +130,9 @@ export class InputModel extends SDK.SDKModel.SDKModel { const eventData = this._dispatchEventDataList[this._dispatchingIndex]; this._lastEventTime = eventData.timestamp; if (InputModel.MouseEventTypes.has(eventData.type)) { - this._dispatchMouseEvent(/** @type {!Input.InputModel.MouseEventData} */ (eventData)); + this._dispatchMouseEvent(/** @type {!MouseEventData} */ (eventData)); } else if (InputModel.KeyboardEventTypes.has(eventData.type)) { - this._dispatchKeyEvent(/** @type {!Input.InputModel.KeyboardEventData} */ (eventData)); + this._dispatchKeyEvent(/** @type {!KeyboardEventData} */ (eventData)); } ++this._dispatchingIndex; @@ -145,7 +145,7 @@ export class InputModel extends SDK.SDKModel.SDKModel { } /** - * @param {!Input.InputModel.MouseEventData} eventData + * @param {!MouseEventData} eventData */ async _dispatchMouseEvent(eventData) { console.assert(InputModel.MouseEventTypes.has(eventData.type)); @@ -165,7 +165,7 @@ export class InputModel extends SDK.SDKModel.SDKModel { } /** - * @param {!Input.InputModel.KeyboardEventData } eventData + * @param {!KeyboardEventData } eventData */ async _dispatchKeyEvent(eventData) { console.assert(InputModel.KeyboardEventTypes.has(eventData.type)); @@ -195,3 +195,12 @@ InputModel.MouseEventTypes = new Map([ InputModel.KeyboardEventTypes = new Map([['keydown', 'keyDown'], ['keyup', 'keyUp'], ['keypress', 'char']]); SDK.SDKModel.SDKModel.register(InputModel, SDK.SDKModel.Capability.Input, false); + +/** @typedef {{type: string, modifiers: number, timestamp: number}} */ +export let EventData; + +/** @typedef {{x: number, y: number, button: number, buttons: number, clickCount: number, deltaX: number, deltaY: number}} */ +export let MouseEventData; + +/** @typedef {{code: string, key: string}} */ +export let KeyboardEventData; diff --git a/front_end/input/input-legacy.js b/front_end/input/input-legacy.js index 9923cd6482..d6976bd3e8 100644 --- a/front_end/input/input-legacy.js +++ b/front_end/input/input-legacy.js @@ -29,10 +29,3 @@ Input.InputTimeline.TracingClient = InputModule.InputTimeline.TracingClient; * @constructor */ Input.InputTimeline.ActionDelegate = InputModule.InputTimeline.ActionDelegate; - -/** @typedef {{type: string, modifiers: number, timestamp: number}} */ -Input.InputModel.EventData; -/** @typedef {{x: number, y: number, button: number, buttons: number, clickCount: number, deltaX: number, deltaY: number}} */ -Input.InputModel.MouseEventData; -/** @typedef {{code: string, key: string}} */ -Input.InputModel.KeyboardEventData; diff --git a/front_end/layer_viewer/layer_viewer-legacy.js b/front_end/layer_viewer/layer_viewer-legacy.js index 0c383ec6e5..d55b99daf9 100644 --- a/front_end/layer_viewer/layer_viewer-legacy.js +++ b/front_end/layer_viewer/layer_viewer-legacy.js @@ -167,6 +167,3 @@ LayerViewer.TransformController.Events = LayerViewerModule.TransformController.E * @enum {string} */ LayerViewer.TransformController.Modes = LayerViewerModule.TransformController.Modes; - -/** @typedef {{borderColor: !Array, borderWidth: number}} */ -LayerViewer.Layers3DView.LayerStyle; diff --git a/front_end/network/NetworkLogView.js b/front_end/network/NetworkLogView.js index 099fcd0f47..12ebb64878 100644 --- a/front_end/network/NetworkLogView.js +++ b/front_end/network/NetworkLogView.js @@ -101,9 +101,9 @@ export class NetworkLogView extends UI.Widget.VBox { this._mainRequestDOMContentLoadedTime = -1; this._highlightedSubstringChanges = []; - /** @type {!Array.} */ + /** @type {!Array.} */ this._filters = []; - /** @type {?Network.NetworkLogView.Filter} */ + /** @type {?Filter} */ this._timeFilter = null; /** @type {?NetworkNode} */ this._hoveredNode = null; @@ -214,7 +214,7 @@ export class NetworkLogView extends UI.Widget.VBox { } /** - * @param {!Network.NetworkLogView.Filter} filter + * @param {!Filter} filter * @param {!SDK.NetworkRequest.NetworkRequest} request * @return {boolean} */ @@ -251,7 +251,7 @@ export class NetworkLogView extends UI.Widget.VBox { /** * @param {string} value - * @return {!Network.NetworkLogView.Filter} + * @return {!Filter} */ static _createRequestDomainFilter(value) { /** @@ -1600,7 +1600,7 @@ export class NetworkLogView extends UI.Widget.VBox { /** * @param {!FilterType} type * @param {string} value - * @return {?Network.NetworkLogView.Filter} + * @return {?Filter} */ _createSpecialFilter(type, value) { switch (type) { @@ -1670,7 +1670,7 @@ export class NetworkLogView extends UI.Widget.VBox { /** * @param {string} value - * @return {?Network.NetworkLogView.Filter} + * @return {?Filter} */ _createSizeFilter(value) { let multiplier = 1; @@ -2153,3 +2153,6 @@ export class GroupLookupInterface { reset() { } } + +/** @typedef {function(!SDK.NetworkRequest.NetworkRequest): boolean} */ +export let Filter; diff --git a/front_end/network/NetworkLogViewColumns.js b/front_end/network/NetworkLogViewColumns.js index cad0bc6162..ac9446f354 100644 --- a/front_end/network/NetworkLogViewColumns.js +++ b/front_end/network/NetworkLogViewColumns.js @@ -40,7 +40,7 @@ export class NetworkLogViewColumns { this._gridMode = true; - /** @type {!Array.} */ + /** @type {!Array.} */ this._columns = []; this._waterfallRequestsAreStale = false; @@ -61,7 +61,7 @@ export class NetworkLogViewColumns { } /** - * @param {!Network.NetworkLogViewColumns.Descriptor} columnConfig + * @param {!Descriptor} columnConfig * @return {!DataGrid.DataGrid.ColumnDescriptor} */ static _convertToDataGridDescriptor(columnConfig) { @@ -95,10 +95,10 @@ export class NetworkLogViewColumns { const defaultColumns = _defaultColumns; const defaultColumnConfig = _defaultColumnConfig; - this._columns = /** @type {!Array} */ ([]); + this._columns = /** @type {!Array} */ ([]); for (const currentConfigColumn of defaultColumns) { - const columnConfig = /** @type {!Network.NetworkLogViewColumns.Descriptor} */ ( - Object.assign({}, defaultColumnConfig, currentConfigColumn)); + const descriptor = Object.assign({}, defaultColumnConfig, currentConfigColumn); + const columnConfig = /** @type {!Descriptor} */ (descriptor); columnConfig.id = columnConfig.id; if (columnConfig.subtitle) { columnConfig.titleDOMFragment = this._makeHeaderFragment(columnConfig.title, columnConfig.subtitle); @@ -386,7 +386,7 @@ export class NetworkLogViewColumns { } /** - * @param {!Network.NetworkLogViewColumns.Descriptor} columnConfig + * @param {!Descriptor} columnConfig */ _toggleColumnVisibility(columnConfig) { this._loadCustomColumnsAndSettings(); @@ -442,9 +442,9 @@ export class NetworkLogViewColumns { const columnConfigs = this._columns.filter(columnConfig => columnConfig.hideable); const nonResponseHeaders = columnConfigs.filter(columnConfig => !columnConfig.isResponseHeader); - /** @type {!Map>} */ + /** @type {!Map>} */ const hideableGroups = new Map(); - /** @type {!Array.} */ + /** @type {!Array.} */ const nonResponseHeadersWithoutGroup = []; // Sort columns into their groups @@ -566,7 +566,7 @@ export class NetworkLogViewColumns { * @param {string} headerTitle * @param {string=} headerId * @param {number=} index - * @return {?Network.NetworkLogViewColumns.Descriptor} + * @return {?Descriptor} */ _addCustomHeader(headerTitle, headerId, index) { if (!headerId) { @@ -592,7 +592,7 @@ export class NetworkLogViewColumns { // Split out the column config from the typed version, as doing it in a single assignment causes // issues with Closure compiler. - const columnConfig = /** @type {!Network.NetworkLogViewColumns.Descriptor} */ (columnConfigBase); + const columnConfig = /** @type {!Descriptor} */ (columnConfigBase); this._columns.splice(index, 0, columnConfig); if (this._dataGrid) { @@ -733,7 +733,7 @@ export const _defaultColumnConfig = { }; /** - * @type {!Array.} column + * @type {!Array.} column */ export const _defaultColumns = [ { @@ -914,3 +914,24 @@ export const WaterfallSortIds = { Duration: 'duration', Latency: 'latency' }; + +/** + * @typedef {{ + * id: string, + * title: string, + * titleDOMFragment: (!DocumentFragment|undefined), + * subtitle: (string|null), + * visible: boolean, + * weight: number, + * hideable: boolean, + * hideableGroup: ?string, + * nonSelectable: boolean, + * sortable: boolean, + * align: (?DataGrid.DataGrid.Align|undefined), + * isResponseHeader: boolean, + * sortingFunction: (!function(!NetworkNode, !NetworkNode):number|undefined), + * isCustomHeader: boolean, + * allowInSortByEvenWhenHidden: boolean + * }} + */ +export let Descriptor; diff --git a/front_end/network/NetworkWaterfallColumn.js b/front_end/network/NetworkWaterfallColumn.js index ba5dec2461..28cd0a8b18 100644 --- a/front_end/network/NetworkWaterfallColumn.js +++ b/front_end/network/NetworkWaterfallColumn.js @@ -69,20 +69,20 @@ export class NetworkWaterfallColumn extends UI.Widget.VBox { this._styleForTimeRangeName = NetworkWaterfallColumn._buildRequestTimeRangeStyle(); const resourceStyleTuple = NetworkWaterfallColumn._buildResourceTypeStyle(); - /** @type {!Map} */ + /** @type {!Map} */ this._styleForWaitingResourceType = resourceStyleTuple[0]; - /** @type {!Map} */ + /** @type {!Map} */ this._styleForDownloadingResourceType = resourceStyleTuple[1]; const baseLineColor = self.UI.themeSupport.patchColorText('#a5a5a5', UI.UIUtils.ThemeSupport.ColorUsage.Foreground); - /** @type {!NetworkWaterfallColumn._LayerStyle} */ + /** @type {!_LayerStyle} */ this._wiskerStyle = {borderColor: baseLineColor, lineWidth: 1}; - /** @type {!NetworkWaterfallColumn._LayerStyle} */ + /** @type {!_LayerStyle} */ this._hoverDetailsStyle = {fillStyle: baseLineColor, lineWidth: 1, borderColor: baseLineColor}; - /** @type {!Map} */ + /** @type {!Map} */ this._pathForStyle = new Map(); - /** @type {!Array} */ + /** @type {!Array} */ this._textLayers = []; /** @type {?CSSStyleDeclaration} */ @@ -90,7 +90,7 @@ export class NetworkWaterfallColumn extends UI.Widget.VBox { } /** - * @return {!Map} + * @return {!Map} */ static _buildRequestTimeRangeStyle() { const types = RequestTimeRangeNames; @@ -112,7 +112,7 @@ export class NetworkWaterfallColumn extends UI.Widget.VBox { } /** - * @return {!Array>} + * @return {!Array>} */ static _buildResourceTypeStyle() { const baseResourceTypeColors = new Map([ @@ -474,7 +474,7 @@ export class NetworkWaterfallColumn extends UI.Widget.VBox { */ _drawLayers(context) { for (const entry of this._pathForStyle) { - const style = /** @type {!NetworkWaterfallColumn._LayerStyle} */ (entry[0]); + const style = /** @type {!_LayerStyle} */ (entry[0]); const path = /** @type {!Path2D} */ (entry[1]); context.save(); context.beginPath(); @@ -676,3 +676,9 @@ export class NetworkWaterfallColumn extends UI.Widget.VBox { context.restore(); } } + +/** @typedef {!{x: number, y: number, text: string}} */ +export let _TextLayer; + +/** @typedef {!{fillStyle: (string|undefined), lineWidth: (number|undefined), borderColor: (string|undefined)}} */ +export let _LayerStyle; diff --git a/front_end/network/RequestTimingView.js b/front_end/network/RequestTimingView.js index 4b3b159de9..4d12817a1d 100644 --- a/front_end/network/RequestTimingView.js +++ b/front_end/network/RequestTimingView.js @@ -92,7 +92,7 @@ export class RequestTimingView extends UI.Widget.VBox { /** * @param {!SDK.NetworkRequest.NetworkRequest} request * @param {number} navigationStart - * @return {!Array.} + * @return {!Array.} */ static calculateRequestTimeRanges(request, navigationStart) { const result = []; @@ -416,3 +416,6 @@ export const ConnectionSetupRangeNames = new Set([ RequestTimeRangeNames.Queueing, RequestTimeRangeNames.Blocking, RequestTimeRangeNames.Connecting, RequestTimeRangeNames.DNS, RequestTimeRangeNames.Proxy, RequestTimeRangeNames.SSL ]); + +/** @typedef {{name: !RequestTimeRangeNames, start: number, end: number}} */ +export let RequestTimeRange; diff --git a/front_end/network/network-legacy.js b/front_end/network/network-legacy.js index 2fd29d8445..2040b44281 100644 --- a/front_end/network/network-legacy.js +++ b/front_end/network/network-legacy.js @@ -152,39 +152,3 @@ Network.ResourceWebSocketFrameNode = NetworkModule.ResourceWebSocketFrameView.Re * @constructor */ Network.SignedExchangeInfoView = NetworkModule.SignedExchangeInfoView.SignedExchangeInfoView; - -/** @typedef {function(!SDK.NetworkRequest): boolean} */ -Network.NetworkLogView.Filter; - -/** - * @typedef {{ - * id: string, - * title: string, - * titleDOMFragment: (!DocumentFragment|undefined), - * subtitle: (string|null), - * visible: boolean, - * weight: number, - * hideable: boolean, - * hideableGroup: ?string, - * nonSelectable: boolean, - * sortable: boolean, - * align: (?DataGrid.DataGrid.Align|undefined), - * isResponseHeader: boolean, - * sortingFunction: (!function(!Network.NetworkNode, !Network.NetworkNode):number|undefined), - * isCustomHeader: boolean, - * allowInSortByEvenWhenHidden: boolean - * }} - */ -Network.NetworkLogViewColumns.Descriptor; - -/** @typedef {{start: number, end: number}} */ -Network.NetworkOverview.Window; - -/** @typedef {!{fillStyle: (string|undefined), lineWidth: (number|undefined), borderColor: (string|undefined)}} */ -Network.NetworkWaterfallColumn._LayerStyle; - -/** @typedef {!{x: number, y: number, text: string}} */ -Network.NetworkWaterfallColumn._TextLayer; - -/** @typedef {{name: !Network.RequestTimeRangeNames, start: number, end: number}} */ -Network.RequestTimeRange; diff --git a/front_end/object_ui/JavaScriptAutocomplete.js b/front_end/object_ui/JavaScriptAutocomplete.js index eeb3b71db0..f4b396c160 100644 --- a/front_end/object_ui/JavaScriptAutocomplete.js +++ b/front_end/object_ui/JavaScriptAutocomplete.js @@ -370,7 +370,7 @@ export class JavaScriptAutocomplete { /** * @this {JavaScriptAutocomplete} * @param {!SDK.RuntimeModel.EvaluationResult} result - * @return {!Promise>} + * @return {!Promise>} */ async function completionsOnGlobal(result) { if (result.error || !!result.exceptionDetails || !result.object) { @@ -510,7 +510,7 @@ export class JavaScriptAutocomplete { } /** - * @param {?Array} propertyGroups + * @param {?Array} propertyGroups * @param {boolean} dotNotation * @param {boolean} bracketNotation * @param {string} expressionString @@ -558,7 +558,7 @@ export class JavaScriptAutocomplete { * @param {boolean} bracketNotation * @param {string} expressionString * @param {string} query - * @param {!Array} propertyGroups + * @param {!Array} propertyGroups * @return {!UI.SuggestBox.Suggestions} */ _completionsForQuery(dotNotation, bracketNotation, expressionString, query, propertyGroups) { @@ -788,3 +788,6 @@ export class JavaScriptAutocompleteConfig { return tooltip; } } + +/** @typedef {{title:(string|undefined), items:Array}} */ +export let CompletionGroup; diff --git a/front_end/object_ui/ObjectPropertiesSection.js b/front_end/object_ui/ObjectPropertiesSection.js index d06ecfc27c..05d7d9acf8 100644 --- a/front_end/object_ui/ObjectPropertiesSection.js +++ b/front_end/object_ui/ObjectPropertiesSection.js @@ -506,7 +506,7 @@ export const maxRenderableStringLength = 10000; export class ObjectPropertiesSectionsTreeOutline extends UI.TreeOutline.TreeOutlineInShadow { /** - * @param {?ObjectUI.ObjectPropertiesSectionsTreeOutlineOptions=} options + * @param {?TreeOutlineOptions=} options */ constructor(options) { super(); @@ -1708,3 +1708,10 @@ export class ExpandableTextPropertyValue extends ObjectPropertyValue { Host.InspectorFrontendHost.InspectorFrontendHostInstance.copyText(this._text); } } + +/** + * @typedef {{ + * readOnly: (boolean|undefined), + * }} + */ +export let TreeOutlineOptions; diff --git a/front_end/object_ui/object_ui-legacy.js b/front_end/object_ui/object_ui-legacy.js index 890b07b6a9..889f0a1310 100644 --- a/front_end/object_ui/object_ui-legacy.js +++ b/front_end/object_ui/object_ui-legacy.js @@ -63,13 +63,3 @@ ObjectUI.ObjectPropertiesSectionsTreeExpandController = /** @constructor */ ObjectUI.RemoteObjectPreviewFormatter = ObjectUIModule.RemoteObjectPreviewFormatter.RemoteObjectPreviewFormatter; - -/** @typedef {{title:(string|undefined), items:Array}} */ -ObjectUI.JavaScriptAutocomplete.CompletionGroup; - -/** - * @typedef {{ - * readOnly: (boolean|undefined), - * }} - */ -ObjectUI.ObjectPropertiesSectionsTreeOutlineOptions;