Skip to content

Commit 7189c1b

Browse files
committed
fix doc lint & lock
1 parent 7bb6ff8 commit 7189c1b

16 files changed

+3850
-3855
lines changed

packages/@ember/debug/ember-inspector-support/adapters/basic.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ export default class BasicAdapter extends BaseObject {
1818
/**
1919
* Uses the current build's config module to determine
2020
* the environment.
21-
*
22-
* @property environment
23-
* @type {String}
2421
*/
2522
get environment() {
2623
if (!this.__environment) {
@@ -40,7 +37,6 @@ export default class BasicAdapter extends BaseObject {
4037
/**
4138
* A wrapper for `console.warn`.
4239
*
43-
* @method warn
4440
*/
4541
warn(...args: any[]) {
4642
return console.warn(...args);
@@ -91,8 +87,6 @@ export default class BasicAdapter extends BaseObject {
9187
* The idea is to control errors triggered by the inspector
9288
* and make sure that users don't get mislead by inspector-caused
9389
* bugs.
94-
*
95-
* @method handleError
9690
* @param {Error} error
9791
*/
9892
handleError(error: any) {
@@ -115,8 +109,6 @@ export default class BasicAdapter extends BaseObject {
115109
116110
A promise that resolves when the connection
117111
with the inspector is set up and ready.
118-
119-
@return {Promise}
120112
*/
121113
connect() {
122114
return new Promise((resolve, reject) => {

packages/@ember/debug/ember-inspector-support/adapters/web-extension.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import BasicAdapter from './basic';
22
import { run } from '@ember/runloop';
33

44
export default class WebExtension extends BasicAdapter {
5-
declare private _channel: MessageChannel;
6-
declare private _chromePort: MessagePort;
5+
private declare _channel: MessageChannel;
6+
private declare _chromePort: MessagePort;
77
init() {
88
this._channel = new MessageChannel();
99
this._chromePort = this._channel?.port1;

packages/@ember/debug/ember-inspector-support/deprecation-debug.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import type SourceMapSupport from '@ember/debug/ember-inspector-support/libs/sou
88

99
export default class DeprecationDebug extends DebugPort {
1010
declare options: any;
11-
declare private _warned: boolean;
11+
private declare _warned: boolean;
1212
declare debounce: any;
13-
declare private _watching: any;
13+
private declare _watching: any;
1414
declare deprecationsToSend: {
1515
stackStr: string;
1616
message: string;
@@ -19,10 +19,10 @@ export default class DeprecationDebug extends DebugPort {
1919
id: string;
2020
sources: any[];
2121
}[];
22-
declare private sourceMap: SourceMapSupport;
22+
private declare sourceMap: SourceMapSupport;
2323
declare groupedDeprecations: any;
2424
declare deprecations: any;
25-
declare private __emberCliConfig: any;
25+
private declare __emberCliConfig: any;
2626
static {
2727
this.prototype.portNamespace = 'deprecation';
2828
this.prototype.sourceMap = new SourceMap();

packages/@ember/debug/ember-inspector-support/general-debug.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,6 @@ export default class GeneralDebug extends DebugPort {
5555
* Contains ember-cli configuration info.
5656
*
5757
* Info used to determine the file paths of an ember-cli app.
58-
*
59-
* @return {Object}
60-
* {String} environment ex: 'development'
61-
* {String} modulePrefix ex: 'my-app'
62-
* {String} podModulePrefix ex: 'my-app/pods'
63-
* {Boolean} usePodsByDefault
6458
*/
6559
emberCliConfig = this.getAppConfig();
6660

@@ -130,10 +124,6 @@ export default class GeneralDebug extends DebugPort {
130124

131125
/**
132126
* Finds a meta tag by searching through a certain meta attribute.
133-
*
134-
* @param {String} attribute
135-
* @param {RegExp} regExp
136-
* @return {Element}
137127
*/
138128
function findMetaTag(attribute: string, regExp = /.*/) {
139129
let metas = document.querySelectorAll(`meta[${attribute}]`);

packages/@ember/debug/ember-inspector-support/index.ts

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,6 @@ function loadEmberDebug(
170170
/**
171171
* Get all the Ember.Application instances from Ember.Namespace.NAMESPACES
172172
* and add our own applicationId and applicationName to them
173-
* @return {*}
174173
*/
175174
function getApplications() {
176175
let namespaces = A(Namespace.NAMESPACES);
@@ -250,10 +249,6 @@ function loadEmberDebug(
250249
/**
251250
* Checks if a version is between two different versions.
252251
* version should be >= left side, < right side
253-
*
254-
* @param {String} version1
255-
* @param {String} version2
256-
* @return {Boolean}
257252
*/
258253
function versionTest(version: string, between: [string, string]) {
259254
let fromVersion = between[0];
@@ -272,10 +267,6 @@ function loadEmberDebug(
272267
* `-1` if version1 < version
273268
* 0 if version1 == version2
274269
* 1 if version1 > version2
275-
*
276-
* @param {String} version1
277-
* @param {String} version2
278-
* @return {Boolean} result of the comparison
279270
*/
280271
function compareVersion(version1: string, version2: string) {
281272
let compared, i;
@@ -292,19 +283,12 @@ function loadEmberDebug(
292283

293284
/**
294285
* Remove -alpha, -beta, etc from versions
295-
*
296-
* @param {String} version
297-
* @return {String} The cleaned up version
298286
*/
299287
function cleanupVersion(version: string) {
300288
return version.replace(/-.*/g, '');
301289
}
302290

303291
/**
304-
* @method compare
305-
* @param {Number} val
306-
* @param {Number} number
307-
* @return {Number}
308292
* 0: same
309293
* -1: <
310294
* 1: >

packages/@ember/debug/ember-inspector-support/libs/render-tree.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,6 @@ export default class RenderTree {
146146
/**
147147
* Sets up the initial options.
148148
*
149-
* @method constructor
150149
* @param {Object} options
151150
* - {owner} owner The Ember app's owner.
152151
* - {Function} retainObject Called to retain an object for future inspection.
@@ -201,9 +200,6 @@ export default class RenderTree {
201200
* bounds: Option<'single' | 'range'>;
202201
* children: SerializedRenderNode[];
203202
* }
204-
*
205-
* @method build
206-
* @return {Array<SerializedRenderNode>} The render nodes tree.
207203
*/
208204
build() {
209205
this._reset();
@@ -218,9 +214,6 @@ export default class RenderTree {
218214

219215
/**
220216
* Find a render node by id.
221-
*
222-
* @param {string} id A render node id.
223-
* @return {Option<SerializedRenderNode>} A render node with the given id, if any.
224217
*/
225218
find(id: string): CapturedRenderNode | null {
226219
let node = this.nodes[id];
@@ -235,7 +228,6 @@ export default class RenderTree {
235228
/**
236229
* Find the deepest enclosing render node for a given DOM node.
237230
*
238-
* @method findNearest
239231
* @param {Node} node A DOM node.
240232
* @param {string} hint The id of the last-matched render node (see comment below).
241233
* @return {Option<SerializedRenderNode>} The deepest enclosing render node, if any.
@@ -280,7 +272,6 @@ export default class RenderTree {
280272
/**
281273
* Get the bounding rect for a given render node id.
282274
*
283-
* @method getBoundingClientRect
284275
* @param {*} id A render node id.
285276
* @return {Option<DOMRect>} The bounding rect, if the render node is found and has valid `bounds`.
286277
*/
@@ -315,7 +306,6 @@ export default class RenderTree {
315306
/**
316307
* Get the DOM range for a give render node id.
317308
*
318-
* @method getRange
319309
* @param {string} id A render node id.
320310
* @return {Option<Range>} The DOM range, if the render node is found and has valid `bounds`.
321311
*/
@@ -343,7 +333,6 @@ export default class RenderTree {
343333
/**
344334
* Scroll the given render node id into view (if the render node is found and has valid `bounds`).
345335
*
346-
* @method scrollIntoView
347336
* @param {string} id A render node id.
348337
*/
349338
scrollIntoView(id: string) {
@@ -368,7 +357,6 @@ export default class RenderTree {
368357
* Inspect the bounds for the given render node id in the "Elements" panel (if the render node
369358
* is found and has valid `bounds`).
370359
*
371-
* @method inspectElement
372360
* @param {string} id A render node id.
373361
*/
374362
inspectElement(id: string) {

packages/@ember/debug/ember-inspector-support/libs/source-map.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ export default class SourceMapSupport extends BaseObject {
1212
/**
1313
* Returns a promise that resolves to an array
1414
* of mapped sourcew.
15-
*
16-
* @param {String} stack The stack trace
17-
* @return {RSVP.Promise}
1815
*/
1916
map(stack: string): Promise<any> {
2017
let parsed = fromStackProperty(stack);

packages/@ember/debug/ember-inspector-support/main.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ class EmberDebug extends BaseObject {
4343
/**
4444
* We use the application's id instead of the owner's id so that we use the same inspector
4545
* instance for the same application even if it was reset (owner changes on reset).
46-
*
47-
* @property applicationId
48-
* @type {String}
4946
*/
5047
get applicationId() {
5148
if (!this.isTesting) {

packages/@ember/debug/ember-inspector-support/models/profile-manager.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,6 @@ export default class ProfileManager {
150150

151151
/**
152152
* Push a new profile into the queue
153-
* @param info
154-
* @return {number}
155153
*/
156154
addToQueue(info: Info) {
157155
const index = this.queue.push(info);

packages/@ember/debug/ember-inspector-support/port.ts

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ export default class Port extends Evented.extend(BaseObject) {
2424
* Unique id per application (not application instance). It's very important
2525
* that this id doesn't change when the app is reset otherwise the inspector
2626
* will no longer recognize the app.
27-
*
28-
* @property uniqueId
29-
* @type {String}
3027
*/
3128
get uniqueId() {
3229
return guidFor(this.namespace?._application, 'ember');
@@ -35,9 +32,6 @@ export default class Port extends Evented.extend(BaseObject) {
3532
init() {
3633
/**
3734
* Stores the timestamp when it was first accessed.
38-
*
39-
* @property now
40-
* @type {Number}
4135
*/
4236
this.now = Date.now();
4337

@@ -93,7 +87,6 @@ export default class Port extends Evented.extend(BaseObject) {
9387
* - Catches all errors during production
9488
* and displays them in a user friendly manner.
9589
*
96-
* @method wrap
9790
* @param {Function} fn
9891
* @return {Mixed} The return value of the passed function
9992
*/

packages/@ember/debug/ember-inspector-support/promise-debug.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import RSVP from 'rsvp';
99
import type PromiseModel from './models/promise';
1010

1111
export default class PromiseDebug extends DebugPort {
12-
declare private __session: any;
12+
private declare __session: any;
1313
declare promiseAssembler: PromiseAssembler;
1414
declare updatedPromises: PromiseModel[];
1515
declare releaseMethods: (() => void)[];

packages/@ember/debug/ember-inspector-support/route-debug.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ const { hasOwnProperty } = Object.prototype;
88

99
export default class RouteDebug extends DebugPort {
1010
_cachedRouteTree = null;
11-
declare private __currentURL: any;
12-
declare private __currentRouter: any;
11+
private declare __currentURL: any;
12+
private declare __currentRouter: any;
1313
init() {
1414
super.init();
1515
this.__currentURL = this.currentURL;

packages/@ember/debug/ember-inspector-support/utils/bound-method.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ function entriesFor(obj: any) {
1414
/**
1515
* Return `method.bind(obj)` or `obj[method].bind(obj)`. When called multiple
1616
* times, the same bound function will be returned.
17-
*
18-
* @param {Object} obj
19-
* @param {String|Symbol|Function} method
20-
* @return {Function}
2117
*/
2218
export default function bound(obj: any, method: string | Function) {
2319
let func;

packages/@ember/debug/ember-inspector-support/utils/name-functions.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/**
22
* Returns a medium sized model name. Makes sure it's maximum 50 characters long.
33
*
4-
* @method modelName
54
* @param {Any} model
65
* @return {String} The model name.
76
*/
@@ -20,7 +19,6 @@ export function modelName(model: any) {
2019
/**
2120
* Takes an Ember Data model and strips out the extra noise from the name.
2221
*
23-
* @method shortModelName
2422
* @param {DS.Model} model
2523
* @return {String} The concise model name.
2624
*/
@@ -33,7 +31,6 @@ export function shortModelName(model: any) {
3331
/**
3432
* Returns the controller name. Strips out extra noise such as `subclass of`.
3533
*
36-
* @method controllerName
3734
* @param {Controller} controller
3835
* @return {String} The controller name
3936
*/
@@ -44,7 +41,6 @@ export function controllerName(controller: any) {
4441
/**
4542
* Cleans up the controller name before returning it.
4643
*
47-
* @method shortControllerName
4844
* @param {Controller} controller
4945
* @return {String} The short controller name
5046
*/
@@ -60,10 +56,6 @@ export function shortControllerName(controller: any) {
6056
/**
6157
* Cleans up an instance name to create shorter/less noisy names.
6258
* Example: `<app@component:textarea::ember545>` becomes `textarea`.
63-
*
64-
* @method cleanupInstanceName
65-
* @param {String} name
66-
* @return {String} The short/cleaner name
6759
*/
6860
function cleanupInstanceName(name: string) {
6961
let match = name.match(/^.+:(.+)::/);
@@ -81,7 +73,6 @@ function cleanupInstanceName(name: string) {
8173
/**
8274
* Cleans up the view name before returning it.
8375
*
84-
* @method shortViewName
8576
* @param {Component} view The component.
8677
* @return {String} The short view name.
8778
*/
@@ -92,7 +83,6 @@ export function shortViewName(view: any) {
9283
/**
9384
* Returns the view name. Removes the `subclass` noise.
9485
*
95-
* @method viewName
9686
* @param {Component} view The component.
9787
* @return {String} The view name.
9888
*/

packages/@ember/debug/ember-inspector-support/view-debug.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ export default class ViewDebug extends DebugPort {
126126
* Opens the "Elements" tab and selects the given DOM node. Doesn't work in all
127127
* browsers/addons (only in the Chrome and FF devtools addons at the time of writing).
128128
*
129-
* @method inspectNode
130129
* @param {Node} node The DOM node to inspect
131130
*/
132131
inspectNode(node: Node) {

0 commit comments

Comments
 (0)