Skip to content

Add more comments #1993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 81 commits into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
61d9bfe
refactor: optimize file system operations by removing async/await for…
Bashamega Apr 23, 2025
7b92b7d
chore: better naming
Bashamega Apr 23, 2025
746f705
feat: extract summary from MDN comments for better documentation
Bashamega Apr 23, 2025
9521a10
generate
Bashamega Apr 23, 2025
a995e00
remove comments
Bashamega Apr 23, 2025
ca08f27
Remove hashing
Bashamega Apr 23, 2025
7f82e1f
regenerate
Bashamega Apr 23, 2025
9afe136
-
Bashamega Apr 23, 2025
a2b7a93
feat: comments for iterator
Bashamega Apr 24, 2025
d6d08f7
Merge branch 'microsoft:main' into descriptions
Bashamega Apr 24, 2025
d65d812
generate
Bashamega Apr 24, 2025
04ba40c
-
Bashamega Apr 24, 2025
7da9e85
-
Bashamega Apr 24, 2025
576b872
-
Bashamega Apr 24, 2025
16ef393
-
Bashamega Apr 24, 2025
5110391
-
Bashamega Apr 24, 2025
63c359d
generate
Bashamega Apr 24, 2025
7a40173
clean
Bashamega Apr 24, 2025
fdddfa6
remove await
Bashamega Apr 25, 2025
968a4e4
simplify
Bashamega Apr 25, 2025
0123276
refactor: extract title generation logic into a separate function
Bashamega Apr 25, 2025
e146dfe
refactor: remove descriptions parameter from emitFlavor and emitWebId…
Bashamega Apr 27, 2025
d97bcb7
-
Bashamega Apr 27, 2025
de83ebc
Merge branch 'microsoft:main' into descriptions
Bashamega Apr 27, 2025
7386df6
generate
Bashamega Apr 27, 2025
619d3c2
merge branches
Bashamega Apr 28, 2025
7d3c431
refactor: optimize file processing in generateDescriptions function u…
Bashamega Apr 28, 2025
3c7d15a
Merge branches
Bashamega Apr 29, 2025
ebfc8c4
Merge branch 'microsoft:main' into descriptions
Bashamega May 4, 2025
ff14106
Update
Bashamega May 4, 2025
88daf24
-
Bashamega May 4, 2025
09a8071
merge
Bashamega May 14, 2025
53d05d3
-
Bashamega May 14, 2025
155f013
-
Bashamega May 14, 2025
fae5ec1
-
Bashamega May 14, 2025
3130a7a
.
Bashamega May 15, 2025
79d9131
use leaf
Bashamega May 15, 2025
615bdb5
Merge branch 'microsoft:main' into descriptions
Bashamega May 17, 2025
ea052dc
-
Bashamega May 21, 2025
bff888b
Merge branch 'descriptions' of https://github.com/Bashamega/TypeScrip…
May 21, 2025
11d8d3e
Update mdn-comments.ts
Bashamega May 21, 2025
94d22b9
Refactor merge function to support optional parameter and update merg…
Bashamega May 28, 2025
d2ee6f5
Merge branch 'descriptions' of https://github.com/Bashamega/TypeScrip…
Bashamega May 28, 2025
241a83c
format
Bashamega May 28, 2025
9e7d2f9
-
Bashamega May 29, 2025
32fee24
Update emitNonCallbackInterfaces to include interfaces without names …
Bashamega May 29, 2025
12a3cb9
-
Bashamega May 29, 2025
262a699
-
Bashamega May 29, 2025
63c7cdb
-
Bashamega May 29, 2025
7e2b12e
-
Bashamega Jun 3, 2025
7ecc60d
-
Bashamega Jun 3, 2025
1848c57
remove try and catch
Bashamega Jun 3, 2025
734c5e0
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
8673704
update logic
Bashamega Jun 3, 2025
c4062ba
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
6f8d929
-
Bashamega Jun 3, 2025
43d9b43
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
dc848db
Update src/build.ts
Bashamega Jun 3, 2025
6ddc417
lint
Bashamega Jun 3, 2025
8cc781b
-
Bashamega Jun 3, 2025
7d81067
Merge branch 'microsoft:main' into descriptions
Bashamega Jun 3, 2025
6a65a54
generate
Bashamega Jun 3, 2025
99cf7ec
-
Bashamega Jun 3, 2025
a931367
Update src/build.ts
Bashamega Jun 3, 2025
e529775
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
4cc342b
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
0ffb148
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
3f65e0f
Update src/build/mdn-comments.ts
Bashamega Jun 3, 2025
20c60b9
fix
Bashamega Jun 3, 2025
3e8433e
-
Bashamega Jun 3, 2025
3877aad
rename
Bashamega Jun 3, 2025
2fc354e
-
Bashamega Jun 3, 2025
0f3a8df
Refactor generatePath function in mdn-comments.ts to simplify return …
Bashamega Jun 3, 2025
3a2afba
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
f449210
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
4120aa3
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
01fca42
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
99655cf
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
a81c050
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
fcdcab9
Update src/build/mdn-comments.ts
saschanaz Jun 3, 2025
d101d73
Apply suggestions from code review
saschanaz Jun 3, 2025
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
-
  • Loading branch information
Bashamega committed Jun 3, 2025
commit 6f8d9299b191d062c9836f741290599dc8da00a9
24 changes: 20 additions & 4 deletions baselines/audioworklet.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,17 @@ interface AbortSignal extends EventTarget {
declare var AbortSignal: {
prototype: AbortSignal;
new(): AbortSignal;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static) */
/**
* The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an AbortSignal/abort_event event).
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static)
*/
abort(reason?: any): AbortSignal;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static) */
/**
* The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static)
*/
any(signals: AbortSignal[]): AbortSignal;
};

Expand Down Expand Up @@ -1314,9 +1322,17 @@ interface URL {
declare var URL: {
prototype: URL;
new(url: string | URL, base?: string | URL): URL;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static) */
/**
* The **`URL.canParse()`** static method of the URL interface returns a boolean indicating whether or not an absolute URL, or a relative URL combined with a base URL, are parsable and valid.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static)
*/
canParse(url: string | URL, base?: string | URL): boolean;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static) */
/**
* The **`URL.parse()`** static method of the URL interface returns a newly created URL object representing the URL defined by the parameters.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static)
*/
parse(url: string | URL, base?: string | URL): URL | null;
};

Expand Down
244 changes: 200 additions & 44 deletions baselines/dom.generated.d.ts

Large diffs are not rendered by default.

94 changes: 75 additions & 19 deletions baselines/serviceworker.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -882,11 +882,23 @@ interface AbortSignal extends EventTarget {
declare var AbortSignal: {
prototype: AbortSignal;
new(): AbortSignal;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static) */
/**
* The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an AbortSignal/abort_event event).
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static)
*/
abort(reason?: any): AbortSignal;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static) */
/**
* The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static)
*/
any(signals: AbortSignal[]): AbortSignal;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/timeout_static) */
/**
* The **`AbortSignal.timeout()`** static method returns an AbortSignal that will automatically abort after a specified time.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/timeout_static)
*/
timeout(milliseconds: number): AbortSignal;
};

Expand Down Expand Up @@ -2688,7 +2700,11 @@ interface DOMPoint extends DOMPointReadOnly {
declare var DOMPoint: {
prototype: DOMPoint;
new(x?: number, y?: number, z?: number, w?: number): DOMPoint;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/fromPoint_static) */
/**
* The **`fromPoint()`** static method of the DOMPoint interface creates and returns a new mutable `DOMPoint` object given a source point.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPoint/fromPoint_static)
*/
fromPoint(other?: DOMPointInit): DOMPoint;
};

Expand Down Expand Up @@ -2739,7 +2755,11 @@ interface DOMPointReadOnly {
declare var DOMPointReadOnly: {
prototype: DOMPointReadOnly;
new(x?: number, y?: number, z?: number, w?: number): DOMPointReadOnly;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/fromPoint_static) */
/**
* The static **DOMPointReadOnly** method `fromPoint()` creates and returns a new `DOMPointReadOnly` object given a source point.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/fromPoint_static)
*/
fromPoint(other?: DOMPointInit): DOMPointReadOnly;
};

Expand Down Expand Up @@ -2829,7 +2849,11 @@ interface DOMRect extends DOMRectReadOnly {
declare var DOMRect: {
prototype: DOMRect;
new(x?: number, y?: number, width?: number, height?: number): DOMRect;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/fromRect_static) */
/**
* The **`fromRect()`** static method of the object with a given location and dimensions.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRect/fromRect_static)
*/
fromRect(other?: DOMRectInit): DOMRect;
};

Expand Down Expand Up @@ -2898,7 +2922,11 @@ interface DOMRectReadOnly {
declare var DOMRectReadOnly: {
prototype: DOMRectReadOnly;
new(x?: number, y?: number, width?: number, height?: number): DOMRectReadOnly;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/fromRect_static) */
/**
* The **`fromRect()`** static method of the object with a given location and dimensions.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/fromRect_static)
*/
fromRect(other?: DOMRectInit): DOMRectReadOnly;
};

Expand Down Expand Up @@ -4380,25 +4408,25 @@ declare var IDBKeyRange: {
prototype: IDBKeyRange;
new(): IDBKeyRange;
/**
* Returns a new IDBKeyRange spanning from lower to upper. If lowerOpen is true, lower is not included in the range. If upperOpen is true, upper is not included in the range.
* The **`bound()`** static method of the IDBKeyRange interface creates a new key range with the specified upper and lower bounds.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBKeyRange/bound_static)
*/
bound(lower: any, upper: any, lowerOpen?: boolean, upperOpen?: boolean): IDBKeyRange;
/**
* Returns a new IDBKeyRange starting at key with no upper bound. If open is true, key is not included in the range.
* The **`lowerBound()`** static method of the By default, it includes the lower endpoint value and is closed.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBKeyRange/lowerBound_static)
*/
lowerBound(lower: any, open?: boolean): IDBKeyRange;
/**
* Returns a new IDBKeyRange spanning only key.
* The **`only()`** static method of the IDBKeyRange interface creates a new key range containing a single value.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBKeyRange/only_static)
*/
only(value: any): IDBKeyRange;
/**
* Returns a new IDBKeyRange with no lower bound and ending at key. If open is true, key is not included in the range.
* The **`upperBound()`** static method of the it includes the upper endpoint value and is closed.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBKeyRange/upperBound_static)
*/
Expand Down Expand Up @@ -5229,7 +5257,11 @@ interface Notification extends EventTarget {
declare var Notification: {
prototype: Notification;
new(title: string, options?: NotificationOptions): Notification;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Notification/permission_static) */
/**
* The **`permission`** read-only static property of the Notification interface indicates the current permission granted by the user for the current origin to display web notifications.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Notification/permission_static)
*/
readonly permission: NotificationPermission;
};

Expand Down Expand Up @@ -5716,7 +5748,11 @@ interface PerformanceObserver {
declare var PerformanceObserver: {
prototype: PerformanceObserver;
new(callback: PerformanceObserverCallback): PerformanceObserver;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserver/supportedEntryTypes_static) */
/**
* The static **`supportedEntryTypes`** read-only property of the PerformanceObserver interface returns an array of the PerformanceEntry.entryType values supported by the user agent.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserver/supportedEntryTypes_static)
*/
readonly supportedEntryTypes: ReadonlyArray<string>;
};

Expand Down Expand Up @@ -6082,7 +6118,11 @@ interface PushManager {
declare var PushManager: {
prototype: PushManager;
new(): PushManager;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/PushManager/supportedContentEncodings_static) */
/**
* The **`supportedContentEncodings`** read-only static property of the PushManager interface returns an array of supported content codings that can be used to encrypt the payload of a push message.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PushManager/supportedContentEncodings_static)
*/
readonly supportedContentEncodings: ReadonlyArray<string>;
};

Expand Down Expand Up @@ -6676,15 +6716,23 @@ interface Response extends Body {
declare var Response: {
prototype: Response;
new(body?: BodyInit | null, init?: ResponseInit): Response;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/error_static) */
/**
* The **`error()`** static method of the Response interface returns a new `Response` object associated with a network error.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/error_static)
*/
error(): Response;
/**
* The **`json()`** method of the Response interface takes a Response stream and reads it to completion.
* The **`json()`** static method of the Response interface returns a `Response` that contains the provided JSON data as body, and a Content-Type header which is set to `application/json`.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/json_static)
*/
json(data: any, init?: ResponseInit): Response;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) */
/**
* The **`redirect()`** static method of the Response interface returns a `Response` resulting in a redirect to the specified URL.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static)
*/
redirect(url: string | URL, status?: number): Response;
};

Expand Down Expand Up @@ -7553,9 +7601,17 @@ interface URL {
declare var URL: {
prototype: URL;
new(url: string | URL, base?: string | URL): URL;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static) */
/**
* The **`URL.canParse()`** static method of the URL interface returns a boolean indicating whether or not an absolute URL, or a relative URL combined with a base URL, are parsable and valid.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static)
*/
canParse(url: string | URL, base?: string | URL): boolean;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static) */
/**
* The **`URL.parse()`** static method of the URL interface returns a newly created URL object representing the URL defined by the parameters.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static)
*/
parse(url: string | URL, base?: string | URL): URL | null;
};

Expand Down
Loading
Loading