lib,tools: remove empty lines between JSDoc tags

This is in preparation for enabling a recommended JSDoc lint rule. PR-URL: #41147 Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Dec 19, 2021 · 29f714b · 29f714b
1 parent 26d2f0b
commit 29f714b
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 25 deletions.
diff --git a/lib/internal/blob.js b/lib/internal/blob.js
@@ -123,7 +123,9 @@ function getSource(source, endings) {
 class Blob {
   /**
    * @typedef {string|ArrayBuffer|ArrayBufferView|Blob} SourcePart
-   *
+   */
+
+  /**
    * @param {SourcePart[]} [sources]
    * @param {{
    *   endings? : string,

diff --git a/lib/internal/webstreams/adapters.js b/lib/internal/webstreams/adapters.js
@@ -79,7 +79,9 @@ const { UV_EOF } = internalBinding('uv');
  * @typedef {import('../../stream').Readable} Readable
  * @typedef {import('./writablestream').WritableStream} WritableStream
  * @typedef {import('./readablestream').ReadableStream} ReadableStream
- *
+ */
+
+/**
  * @typedef {import('../abort_controller').AbortSignal} AbortSignal
  */
 
@@ -525,7 +527,9 @@ function newStreamReadableFromReadableStream(readableStream, options = {}) {
  * @typedef {import('./readablestream').ReadableWritablePair
  * } ReadableWritablePair
  * @typedef {import('../../stream').Duplex} Duplex
- *
+ */
+
+/**
  * @param {Duplex} duplex
  * @returns {ReadableWritablePair}
  */

diff --git a/lib/internal/webstreams/queuingstrategies.js b/lib/internal/webstreams/queuingstrategies.js
@@ -38,7 +38,9 @@ const isCountQueuingStrategy =
  * @callback QueuingStrategySize
  * @param {any} chunk
  * @returns {number}
- *
+ */
+
+/**
  * @typedef {{
  *   highWaterMark : number,
  *   size? : QueuingStrategySize,

diff --git a/lib/internal/webstreams/readablestream.js b/lib/internal/webstreams/readablestream.js
@@ -140,45 +140,60 @@ const kPull = Symbol('kPull');
  * @typedef {import('./queuingstrategies').QueuingStrategySize
  * } QueuingStrategySize
  * @typedef {import('./writablestream').WritableStream} WritableStream
- *
+ */
+
+/**
  * @typedef {ReadableStreamDefaultController | ReadableByteStreamController
  * } ReadableStreamController
- *
+ */
+
+/**
  * @typedef {ReadableStreamDefaultReader | ReadableStreamBYOBReader
  * } ReadableStreamReader
- *
+ */
+
+/**
  * @callback UnderlyingSourceStartCallback
  * @param {ReadableStreamController} controller
  * @returns { any | Promise<void> }
- *
+ */
+
+/**
  * @callback UnderlyingSourcePullCallback
  * @param {ReadableStreamController} controller
  * @returns { Promise<void> }
- *
+ */
+
+/**
  * @callback UnderlyingSourceCancelCallback
  * @param {any} reason
  * @returns { Promise<void> }
- *
+ */
+
+/**
  * @typedef {{
  *   readable: ReadableStream,
  *   writable: WritableStream,
  * }} ReadableWritablePair
- *
+ */
+
+/**
  * @typedef {{
  *   preventClose? : boolean,
  *   preventAbort? : boolean,
  *   preventCancel? : boolean,
  *   signal? : AbortSignal,
  * }} StreamPipeOptions
- *
+ */
+
+/**
  * @typedef {{
  *   start? : UnderlyingSourceStartCallback,
  *   pull? : UnderlyingSourcePullCallback,
  *   cancel? : UnderlyingSourceCancelCallback,
  *   type? : "bytes",
  *   autoAllocateChunkSize? : number
  * }} UnderlyingSource
- *
  */
 
 class ReadableStream {

diff --git a/lib/internal/webstreams/transformstream.js b/lib/internal/webstreams/transformstream.js
@@ -70,19 +70,27 @@ const assert = require('internal/assert');
  * } QueuingStrategy
  * @typedef {import('./queuingstrategies').QueuingStrategySize
  * } QueuingStrategySize
- *
+ */
+
+/**
  * @callback TransformerStartCallback
  * @param {TransformStreamDefaultController} controller;
- *
+ */
+
+/**
  * @callback TransformerFlushCallback
  * @param {TransformStreamDefaultController} controller;
  * @returns {Promise<void>}
- *
+ */
+
+/**
  * @callback TransformerTransformCallback
  * @param {any} chunk
  * @param {TransformStreamDefaultController} controller
  * @returns {Promise<void>}
- *
+ */
+
+/**
  * @typedef {{
  *  start? : TransformerStartCallback,
  *  transform? : TransformerTransformCallback,

diff --git a/lib/internal/webstreams/writablestream.js b/lib/internal/webstreams/writablestream.js
@@ -83,22 +83,32 @@ const kError = Symbol('kError');
  * } QueuingStrategy
  * @typedef {import('./queuingstrategies').QueuingStrategySize
  * } QueuingStrategySize
- *
+ */
+
+/**
  * @callback UnderlyingSinkStartCallback
  * @param {WritableStreamDefaultController} controller
- *
+ */
+
+/**
  * @callback UnderlyingSinkWriteCallback
  * @param {any} chunk
  * @param {WritableStreamDefaultController} controller
  * @returns {Promise<void>}
- *
+ */
+
+/**
  * @callback UnderlyingSinkCloseCallback
  * @returns {Promise<void>}
- *
+ */
+
+/**
  * @callback UnderlyingSinkAbortCallback
  * @param {any} reason
  * @returns {Promise<void>}
- *
+ */
+
+/**
  * @typedef {{
  *   start? : UnderlyingSinkStartCallback,
  *   write? : UnderlyingSinkWriteCallback,

diff --git a/tools/eslint-rules/crypto-check.js b/tools/eslint-rules/crypto-check.js
@@ -1,9 +1,6 @@
 /**
  * @fileoverview Check that common.hasCrypto is used if crypto, tls,
  * https, or http2 modules are required.
- *
- * This rule can be ignored using // eslint-disable-line crypto-check
- *
  * @author Daniel Bevenius <[email protected]>
  */
 'use strict';