Skip to content

Commit 174b76c

Browse files
authored
Fix incorrect extract of comments (#2077)
Co-authored-by: saschanaz <[email protected]>
1 parent 9a0f379 commit 174b76c

28 files changed

+3529
-3539
lines changed

baselines/audioworklet.generated.d.ts

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ interface AudioWorkletGlobalScope extends WorkletGlobalScope {
281281
*/
282282
readonly sampleRate: number;
283283
/**
284-
* The **`registerProcessor`** method of the from AudioWorkletProcessor interface under a specified _name_.
284+
* The **`registerProcessor`** method of the AudioWorkletGlobalScope interface registers a class constructor derived from AudioWorkletProcessor interface under a specified _name_.
285285
*
286286
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor)
287287
*/
@@ -300,7 +300,7 @@ declare var AudioWorkletGlobalScope: {
300300
*/
301301
interface AudioWorkletProcessor {
302302
/**
303-
* The read-only **`port`** property of the The MessagePort object that is connecting the `AudioWorkletProcessor` and the associated `AudioWorkletNode`.
303+
* The read-only **`port`** property of the AudioWorkletProcessor interface returns the associated MessagePort.
304304
*
305305
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletProcessor/port)
306306
*/
@@ -413,13 +413,13 @@ interface DOMException extends Error {
413413
*/
414414
readonly code: number;
415415
/**
416-
* The **`message`** read-only property of the a message or description associated with the given error name.
416+
* The **`message`** read-only property of the DOMException interface returns a string representing a message or description associated with the given error name.
417417
*
418418
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message)
419419
*/
420420
readonly message: string;
421421
/**
422-
* The **`name`** read-only property of the one of the strings associated with an error name.
422+
* The **`name`** read-only property of the DOMException interface returns a string that contains one of the strings associated with an error name.
423423
*
424424
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name)
425425
*/
@@ -565,7 +565,7 @@ interface Event {
565565
*/
566566
readonly cancelable: boolean;
567567
/**
568-
* The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.
568+
* The read-only **`composed`** property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
569569
*
570570
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)
571571
*/
@@ -583,13 +583,13 @@ interface Event {
583583
*/
584584
readonly defaultPrevented: boolean;
585585
/**
586-
* The **`eventPhase`** read-only property of the being evaluated.
586+
* The **`eventPhase`** read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
587587
*
588588
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)
589589
*/
590590
readonly eventPhase: number;
591591
/**
592-
* The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.
592+
* The **`isTrusted`** read-only property of the Event interface is a boolean value that is `true` when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via EventTarget.dispatchEvent().
593593
*
594594
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)
595595
*/
@@ -609,7 +609,7 @@ interface Event {
609609
*/
610610
readonly srcElement: EventTarget | null;
611611
/**
612-
* The read-only **`target`** property of the dispatched.
612+
* The read-only **`target`** property of the Event interface is a reference to the object onto which the event was dispatched.
613613
*
614614
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)
615615
*/
@@ -646,7 +646,7 @@ interface Event {
646646
*/
647647
preventDefault(): void;
648648
/**
649-
* The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.
649+
* The **`stopImmediatePropagation()`** method of the Event interface prevents other listeners of the same event from being called.
650650
*
651651
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
652652
*/
@@ -725,31 +725,31 @@ interface GenericTransformStream {
725725
*/
726726
interface MessageEvent<T = any> extends Event {
727727
/**
728-
* The **`data`** read-only property of the The data sent by the message emitter; this can be any data type, depending on what originated this event.
728+
* The **`data`** read-only property of the MessageEvent interface represents the data sent by the message emitter.
729729
*
730730
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data)
731731
*/
732732
readonly data: T;
733733
/**
734-
* The **`lastEventId`** read-only property of the unique ID for the event.
734+
* The **`lastEventId`** read-only property of the MessageEvent interface is a string representing a unique ID for the event.
735735
*
736736
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId)
737737
*/
738738
readonly lastEventId: string;
739739
/**
740-
* The **`origin`** read-only property of the origin of the message emitter.
740+
* The **`origin`** read-only property of the MessageEvent interface is a string representing the origin of the message emitter.
741741
*
742742
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin)
743743
*/
744744
readonly origin: string;
745745
/**
746-
* The **`ports`** read-only property of the containing all MessagePort objects sent with the message, in order.
746+
* The **`ports`** read-only property of the MessageEvent interface is an array of MessagePort objects containing all MessagePort objects sent with the message, in order.
747747
*
748748
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports)
749749
*/
750750
readonly ports: ReadonlyArray<MessagePort>;
751751
/**
752-
* The **`source`** read-only property of the a WindowProxy, MessagePort, or a `MessageEventSource` (which can be a WindowProxy, message emitter.
752+
* The **`source`** read-only property of the MessageEvent interface is a `MessageEventSource` (which can be a WindowProxy, MessagePort, or ServiceWorker object) representing the message emitter.
753753
*
754754
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source)
755755
*/
@@ -797,7 +797,7 @@ interface MessagePort extends EventTarget, MessageEventTarget<MessagePort> {
797797
*/
798798
close(): void;
799799
/**
800-
* The **`postMessage()`** method of the transfers ownership of objects to other browsing contexts.
800+
* The **`postMessage()`** method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
801801
*
802802
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage)
803803
*/
@@ -827,7 +827,7 @@ declare var MessagePort: {
827827
*/
828828
interface PromiseRejectionEvent extends Event {
829829
/**
830-
* The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript rejected.
830+
* The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript Promise which was rejected.
831831
*
832832
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise)
833833
*/
@@ -927,7 +927,7 @@ interface ReadableStream<R = any> {
927927
*/
928928
pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>;
929929
/**
930-
* The **`tee()`** method of the two-element array containing the two resulting branches as new ReadableStream instances.
930+
* The **`tee()`** method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.
931931
*
932932
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee)
933933
*/
@@ -1004,7 +1004,7 @@ declare var ReadableStreamBYOBRequest: {
10041004
*/
10051005
interface ReadableStreamDefaultController<R = any> {
10061006
/**
1007-
* The **`desiredSize`** read-only property of the required to fill the stream's internal queue.
1007+
* The **`desiredSize`** read-only property of the ReadableStreamDefaultController interface returns the desired size required to fill the stream's internal queue.
10081008
*
10091009
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize)
10101010
*/
@@ -1016,13 +1016,13 @@ interface ReadableStreamDefaultController<R = any> {
10161016
*/
10171017
close(): void;
10181018
/**
1019-
* The **`enqueue()`** method of the ```js-nolint enqueue(chunk) ``` - `chunk` - : The chunk to enqueue.
1019+
* The **`enqueue()`** method of the ReadableStreamDefaultController interface enqueues a given chunk in the associated stream.
10201020
*
10211021
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue)
10221022
*/
10231023
enqueue(chunk?: R): void;
10241024
/**
1025-
* The **`error()`** method of the with the associated stream to error.
1025+
* The **`error()`** method of the ReadableStreamDefaultController interface causes any future interactions with the associated stream to error.
10261026
*
10271027
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error)
10281028
*/
@@ -1300,7 +1300,7 @@ interface URL {
13001300
*/
13011301
search: string;
13021302
/**
1303-
* The **`searchParams`** read-only property of the access to the [MISSING: httpmethod('GET')] decoded query arguments contained in the URL.
1303+
* The **`searchParams`** read-only property of the URL interface returns a URLSearchParams object allowing access to the GET decoded query arguments contained in the URL.
13041304
*
13051305
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams)
13061306
*/
@@ -1312,7 +1312,7 @@ interface URL {
13121312
*/
13131313
username: string;
13141314
/**
1315-
* The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as ```js-nolint toJSON() ``` None.
1315+
* The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as URL.toString().
13161316
*
13171317
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON)
13181318
*/
@@ -1463,7 +1463,7 @@ interface WritableStreamDefaultController {
14631463
*/
14641464
readonly signal: AbortSignal;
14651465
/**
1466-
* The **`error()`** method of the with the associated stream to error.
1466+
* The **`error()`** method of the WritableStreamDefaultController interface causes any future interactions with the associated stream to error.
14671467
*
14681468
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error)
14691469
*/
@@ -1482,43 +1482,43 @@ declare var WritableStreamDefaultController: {
14821482
*/
14831483
interface WritableStreamDefaultWriter<W = any> {
14841484
/**
1485-
* The **`closed`** read-only property of the the stream errors or the writer's lock is released.
1485+
* The **`closed`** read-only property of the WritableStreamDefaultWriter interface returns a Promise that fulfills if the stream becomes closed, or rejects if the stream errors or the writer's lock is released.
14861486
*
14871487
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed)
14881488
*/
14891489
readonly closed: Promise<void>;
14901490
/**
1491-
* The **`desiredSize`** read-only property of the to fill the stream's internal queue.
1491+
* The **`desiredSize`** read-only property of the WritableStreamDefaultWriter interface returns the desired size required to fill the stream's internal queue.
14921492
*
14931493
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize)
14941494
*/
14951495
readonly desiredSize: number | null;
14961496
/**
1497-
* The **`ready`** read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.
1497+
* The **`ready`** read-only property of the WritableStreamDefaultWriter interface returns a Promise that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.
14981498
*
14991499
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready)
15001500
*/
15011501
readonly ready: Promise<void>;
15021502
/**
1503-
* The **`abort()`** method of the the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
1503+
* The **`abort()`** method of the WritableStreamDefaultWriter interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
15041504
*
15051505
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort)
15061506
*/
15071507
abort(reason?: any): Promise<void>;
15081508
/**
1509-
* The **`close()`** method of the stream.
1509+
* The **`close()`** method of the WritableStreamDefaultWriter interface closes the associated writable stream.
15101510
*
15111511
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close)
15121512
*/
15131513
close(): Promise<void>;
15141514
/**
1515-
* The **`releaseLock()`** method of the corresponding stream.
1515+
* The **`releaseLock()`** method of the WritableStreamDefaultWriter interface releases the writer's lock on the corresponding stream.
15161516
*
15171517
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock)
15181518
*/
15191519
releaseLock(): void;
15201520
/**
1521-
* The **`write()`** method of the operation.
1521+
* The **`write()`** method of the WritableStreamDefaultWriter interface writes a passed chunk of data to a WritableStream and its underlying sink, then returns a Promise that resolves to indicate the success or failure of the write operation.
15221522
*
15231523
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write)
15241524
*/
@@ -1938,7 +1938,7 @@ declare var currentTime: number;
19381938
*/
19391939
declare var sampleRate: number;
19401940
/**
1941-
* The **`registerProcessor`** method of the from AudioWorkletProcessor interface under a specified _name_.
1941+
* The **`registerProcessor`** method of the AudioWorkletGlobalScope interface registers a class constructor derived from AudioWorkletProcessor interface under a specified _name_.
19421942
*
19431943
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioWorkletGlobalScope/registerProcessor)
19441944
*/

0 commit comments

Comments
 (0)