Skip to content

Commit 1f9a0a5

Browse files
committed
tools: fix jsdoc lint
1 parent 8d83ae7 commit 1f9a0a5

19 files changed

+0
-36
lines changed

benchmark/common.js

-1
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,6 @@ function getUrlData(withBase) {
374374
* The 'wpt' type contains about 400 data points when `withBase` is true,
375375
* and 200 data points when `withBase` is false.
376376
* Other types contain 200 data points with or without base.
377-
*
378377
* @param {string} type Type of the data, 'wpt' or a key of `urls`
379378
* @param {number} e The repetition of the data, as exponent of 2
380379
* @param {boolean} withBase Whether to include a base URL

lib/internal/async_hooks.js

-1
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,6 @@ function clearDefaultTriggerAsyncId() {
445445

446446
/**
447447
* Sets a default top level trigger ID to be used
448-
*
449448
* @template {Array<unknown>} T
450449
* @template {unknown} R
451450
* @param {number} triggerAsyncId

lib/internal/errors.js

-5
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,6 @@ const captureLargerStackTrace = hideStackFrames(
499499
* function UVException using a context object with data assembled in C++.
500500
* The goal is to migrate them to ERR_* errors later when compatibility is
501501
* not a concern.
502-
*
503502
* @param {object} ctx
504503
* @returns {Error}
505504
*/
@@ -551,7 +550,6 @@ const uvException = hideStackFrames(function uvException(ctx) {
551550
* This creates an error compatible with errors produced in the C++
552551
* This function should replace the deprecated
553552
* `exceptionWithHostPort()` function.
554-
*
555553
* @param {number} err - A libuv error number
556554
* @param {string} syscall
557555
* @param {string} address
@@ -591,7 +589,6 @@ const uvExceptionWithHostPort = hideStackFrames(
591589

592590
/**
593591
* This used to be util._errnoException().
594-
*
595592
* @param {number} err - A libuv error number
596593
* @param {string} syscall
597594
* @param {string} [original]
@@ -725,7 +722,6 @@ let maxStack_ErrorMessage;
725722
* Returns true if `err.name` and `err.message` are equal to engine-specific
726723
* values indicating max call stack size has been exceeded.
727724
* "Maximum call stack size exceeded" in V8.
728-
*
729725
* @param {Error} err
730726
* @returns {boolean}
731727
*/
@@ -857,7 +853,6 @@ class AbortError extends Error {
857853

858854
/**
859855
* This creates a generic Node.js error.
860-
*
861856
* @param {string} message The error message.
862857
* @param {object} errorProperties Object with additional properties to be added to the error.
863858
* @returns {Error}

lib/internal/modules/esm/fetch_module.js

-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,6 @@ async function isLocalAddress(hostname) {
235235
*
236236
* In cases where the request & response have already settled, this returns the
237237
* cache value synchronously.
238-
*
239238
* @param {URL} parsed
240239
* @param {ESModuleContext} context
241240
* @returns {ReturnType<typeof fetchWithRedirects>}

lib/internal/modules/esm/hooks.js

-2
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,6 @@ class Hooks {
193193
* Internally, this behaves like a backwards iterator, wherein the stack of
194194
* hooks starts at the top and each call to `nextResolve()` moves down 1 step
195195
* until it reaches the bottom or short-circuits.
196-
*
197196
* @param {string} originalSpecifier The specified URL path of the module to
198197
* be resolved.
199198
* @param {string} [parentURL] The URL path of the module's parent.
@@ -324,7 +323,6 @@ class Hooks {
324323
* Internally, this behaves like a backwards iterator, wherein the stack of
325324
* hooks starts at the top and each call to `nextLoad()` moves down 1 step
326325
* until it reaches the bottom or short-circuits.
327-
*
328326
* @param {URL['href']} url The URL/path of the module to be loaded
329327
* @param {object} context Metadata about the module
330328
* @returns {Promise<{ format: ModuleFormat, source: ModuleSource }>}

lib/internal/modules/esm/loader.js

-5
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,6 @@ class DefaultModuleLoader {
236236
*
237237
* This method must NOT be renamed: it functions as a dynamic import on a
238238
* loader module.
239-
*
240239
* @param {string | string[]} specifiers Path(s) to the module.
241240
* @param {string} parentURL Path of the parent importing the module.
242241
* @param {Record<string, string>} importAssertions Validations for the
@@ -286,7 +285,6 @@ class DefaultModuleLoader {
286285

287286
/**
288287
* Resolve the location of the module.
289-
*
290288
* @param {string} originalSpecifier The specified URL path of the module to
291289
* be resolved.
292290
* @param {string} [parentURL] The URL path of the module's parent.
@@ -309,7 +307,6 @@ class DefaultModuleLoader {
309307

310308
/**
311309
* Provide source that is understood by one of Node's translators.
312-
*
313310
* @param {URL['href']} url The URL/path of the module to be loaded
314311
* @param {object} [context] Metadata about the module
315312
* @returns {Promise<{ format: ModuleFormat, source: ModuleSource }>}
@@ -354,7 +351,6 @@ class CustomizedModuleLoader extends DefaultModuleLoader {
354351

355352
/**
356353
* Resolve the location of the module.
357-
*
358354
* @param {string} originalSpecifier The specified URL path of the module to
359355
* be resolved.
360356
* @param {string} [parentURL] The URL path of the module's parent.
@@ -389,7 +385,6 @@ class CustomizedModuleLoader extends DefaultModuleLoader {
389385

390386
/**
391387
* Provide source that is understood by one of Node's translators.
392-
*
393388
* @param {URL['href']} url The URL/path of the module to be loaded
394389
* @param {object} [context] Metadata about the module
395390
* @returns {Promise<{ format: ModuleFormat, source: ModuleSource }>}

lib/internal/per_context/primordials.js

-1
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,6 @@ const {
314314
* Because these functions are used by `makeSafe`, which is exposed on the
315315
* `primordials` object, it's important to use const references to the
316316
* primordials that they use.
317-
*
318317
* @template {Iterable} T
319318
* @template {*} TReturn
320319
* @template {*} TNext

lib/internal/policy/manifest.js

-1
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,6 @@ class Manifest {
418418
* the prototype to `null` for values or by running prior to any user code.
419419
*
420420
* `manifestURL` is a URL to resolve relative locations against.
421-
*
422421
* @param {object} obj
423422
* @param {string} manifestHREF
424423
*/

lib/internal/url.js

-1
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,6 @@ ObjectDefineProperties(URLSearchParams.prototype, {
693693
*
694694
* We use `href` and `protocol` as they are the only properties that are
695695
* easy to retrieve and calculate due to the lazy nature of the getters.
696-
*
697696
* @param {*} self
698697
* @returns {self is URL}
699698
*/

lib/internal/util/inspect.js

-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,6 @@ function getUserOptions(ctx, isCrossContext) {
301301
/**
302302
* Echos the value of any input. Tries to print the value out
303303
* in the best way possible given the different types.
304-
*
305304
* @param {any} value The value to print out.
306305
* @param {object} opts Optional options object that alters the output.
307306
*/

lib/internal/util/parse_args/parse_args.js

-5
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ function getMainArgs() {
7373

7474
/**
7575
* In strict mode, throw for possible usage errors like --foo --bar
76-
*
7776
* @param {object} token - from tokens as available from parseArgs
7877
*/
7978
function checkOptionLikeValue(token) {
@@ -91,7 +90,6 @@ To specify an option argument starting with a dash use ${example}.`;
9190

9291
/**
9392
* In strict mode, throw for usage errors.
94-
*
9593
* @param {object} config - from config passed to parseArgs
9694
* @param {object} token - from tokens as available from parseArgs
9795
*/
@@ -116,7 +114,6 @@ function checkOptionUsage(config, token) {
116114

117115
/**
118116
* Store the option value in `values`.
119-
*
120117
* @param {string} longOption - long option name e.g. 'foo'
121118
* @param {string|undefined} optionValue - value from user args
122119
* @param {object} options - option configs, from parseArgs({ options })
@@ -148,7 +145,6 @@ function storeOption(longOption, optionValue, options, values) {
148145

149146
/**
150147
* Store the default option value in `values`.
151-
*
152148
* @param {string} longOption - long option name e.g. 'foo'
153149
* @param {string
154150
* | boolean
@@ -169,7 +165,6 @@ function storeDefaultOption(longOption, optionValue, values) {
169165
* - option (along with value, if any)
170166
* - positional
171167
* - option-terminator
172-
*
173168
* @param {string[]} args - from parseArgs({ args }) or mainArgs
174169
* @param {object} options - option configs, from parseArgs({ options })
175170
*/

lib/internal/util/parse_args/utils.js

-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ function findLongOptionForShort(shortOption, options) {
173173
/**
174174
* Check if the given option includes a default value
175175
* and that option has not been set by the input args.
176-
*
177176
* @param {string} longOption - long option name e.g. 'foo'
178177
* @param {object} optionConfig - the option configuration properties
179178
* @param {object} values - option values returned in `values` by parseArgs

lib/internal/validators.js

-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ const modeDesc = 'must be a 32-bit unsigned integer or an octal string';
6161
* converted to 32-bit unsigned integers or non-negative signed integers in the
6262
* C++ land, but any value higher than 0o777 will result in platform-specific
6363
* behaviors.
64-
*
6564
* @param {*} value Values to be validated
6665
* @param {string} name Name of the argument
6766
* @param {number} [def] If specified, will be returned for invalid values

lib/os.js

-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ function loadavg() {
126126
/**
127127
* Returns an array of objects containing information about each
128128
* logical CPU core.
129-
*
130129
* @returns {Array<{
131130
* model: string,
132131
* speed: number,

lib/string_decoder.js

-4
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ const kNativeDecoder = Symbol('kNativeDecoder');
5454
// modules monkey-patch it to support additional encodings
5555
/**
5656
* Normalize encoding notation
57-
*
5857
* @param {string} enc
5958
* @returns {"utf8" | "utf16le" | "hex" | "ascii"
6059
* | "base64" | "latin1" | "base64url"}
@@ -78,7 +77,6 @@ for (let i = 0; i < encodings.length; ++i)
7877
* StringDecoder provides an interface for efficiently splitting a series of
7978
* buffers into a series of JS strings without breaking apart multi-byte
8079
* characters.
81-
*
8280
* @param {string} [encoding=utf-8]
8381
*/
8482
function StringDecoder(encoding) {
@@ -90,7 +88,6 @@ function StringDecoder(encoding) {
9088
/**
9189
* Returns a decoded string, omitting any incomplete multi-bytes
9290
* characters at the end of the Buffer, or TypedArray, or DataView
93-
*
9491
* @param {string | Buffer | TypedArray | DataView} buf
9592
* @returns {string}
9693
* @throws {TypeError} Throws when buf is not in one of supported types
@@ -112,7 +109,6 @@ StringDecoder.prototype.write = function write(buf) {
112109
* Returns any remaining input stored in the internal buffer as a string.
113110
* After end() is called, the stringDecoder object can be reused for new
114111
* input.
115-
*
116112
* @param {string | Buffer | TypedArray | DataView} [buf]
117113
* @returns {string}
118114
*/

lib/util.js

-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,6 @@ function log(...args) {
231231
* during bootstrapping this function needs to be rewritten using some native
232232
* functions as prototype setup using normal JavaScript does not work as
233233
* expected during bootstrapping (see mirror.js in r114903).
234-
*
235234
* @param {Function} ctor Constructor function which needs to inherit the
236235
* prototype.
237236
* @param {Function} superCtor Constructor function to inherit prototype from.

test/async-hooks/hook-checks.js

-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ const assert = require('assert');
55
/**
66
* Checks the expected invocations against the invocations that actually
77
* occurred.
8-
*
98
* @name checkInvocations
109
* @function
1110
* @param {object} activity including timestamps for each life time event,

test/common/assertSnapshot.js

-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ async function assertSnapshot(actual, filename = process.argv[1]) {
4848
* both of which can be used as an example for writing your own
4949
* compose multiple transforms by passing them as arguments to the transform function:
5050
* assertSnapshot.transform(assertSnapshot.replaceStackTrace, assertSnapshot.replaceWindowsLineEndings)
51-
*
5251
* @param {string} filename
5352
* @param {function(string): string} [transform]
5453
* @returns {Promise<void>}

test/common/wpt.js

-2
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,6 @@ class WPTRunner {
780780
/**
781781
* Report the status of each specific test case (there could be multiple
782782
* in one test file).
783-
*
784783
* @param {WPTTestSpec} spec
785784
* @param {Test} test The Test object returned by WPT harness
786785
*/
@@ -795,7 +794,6 @@ class WPTRunner {
795794

796795
/**
797796
* Report the status of each WPT test (one per file)
798-
*
799797
* @param {WPTTestSpec} spec
800798
* @param {object} harnessStatus - The status object returned by WPT harness.
801799
*/

0 commit comments

Comments
 (0)