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 8cc781bfa868b558ec44cda1277c68d33104dcee
114 changes: 95 additions & 19 deletions baselines/audioworklet.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1692,44 +1692,120 @@ declare namespace WebAssembly {
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console)
*/
interface Console {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert_static) */
/**
* The **`console.assert()`** static method writes an error message to the console if the assertion is false.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert_static)
*/
assert(condition?: boolean, ...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static) */
/**
* The **`console.clear()`** static method clears the console if possible.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static)
*/
clear(): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static) */
/**
* The **`console.count()`** static method logs the number of times that this particular call to `count()` has been called.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static)
*/
count(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static) */
/**
* The **`console.countReset()`** static method resets counter used with console/count_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static)
*/
countReset(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static) */
/**
* The **`console.debug()`** static method outputs a message to the console at the 'debug' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static)
*/
debug(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static) */
/**
* The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static)
*/
dir(item?: any, options?: any): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static) */
/**
* The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static)
*/
dirxml(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static) */
/**
* The **`console.error()`** static method outputs a message to the console at the 'error' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static)
*/
error(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static) */
/**
* The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console/groupEnd_static is called.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static)
*/
group(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static) */
/**
* The **`console.groupCollapsed()`** static method creates a new inline group in the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static)
*/
groupCollapsed(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static) */
/**
* The **`console.groupEnd()`** static method exits the current inline group in the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static)
*/
groupEnd(): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static) */
/**
* The **`console.info()`** static method outputs a message to the console at the 'info' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static)
*/
info(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static) */
/**
* The **`console.log()`** static method outputs a message to the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static)
*/
log(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static) */
/**
* The **`console.table()`** static method displays tabular data as a table.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static)
*/
table(tabularData?: any, properties?: string[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static) */
/**
* The **`console.time()`** static method starts a timer you can use to track how long an operation takes.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static)
*/
time(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static) */
/**
* The **`console.timeEnd()`** static method stops a timer that was previously started by calling console/time_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static)
*/
timeEnd(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static) */
/**
* The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console/time_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static)
*/
timeLog(label?: string, ...data: any[]): void;
timeStamp(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static) */
/**
* The **`console.trace()`** static method outputs a stack trace to the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static)
*/
trace(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static) */
/**
* The **`console.warn()`** static method outputs a warning message to the console at the 'warning' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static)
*/
warn(...data: any[]): void;
}

Expand Down
138 changes: 115 additions & 23 deletions baselines/dom.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37426,7 +37426,11 @@ declare var XSLTProcessor: {

/** The **`CSS`** interface holds useful CSS-related methods. */
declare namespace CSS {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/highlights_static) */
/**
* The static, read-only **`highlights`** property of the CSS interface provides access to the `HighlightRegistry` used to style arbitrary text ranges using the css_custom_highlight_api.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/highlights_static)
*/
var highlights: HighlightRegistry;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
function Hz(value: number): CSSUnitValue;
Expand Down Expand Up @@ -37471,7 +37475,11 @@ declare namespace CSS {
function dvw(value: number): CSSUnitValue;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
function em(value: number): CSSUnitValue;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/escape_static) */
/**
* The **`CSS.escape()`** static method returns a string containing the escaped string passed as parameter, mostly for use as part of a CSS selector.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/escape_static)
*/
function escape(ident: string): string;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
function ex(value: number): CSSUnitValue;
Expand Down Expand Up @@ -37513,7 +37521,11 @@ declare namespace CSS {
function rad(value: number): CSSUnitValue;
function rcap(value: number): CSSUnitValue;
function rch(value: number): CSSUnitValue;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/registerProperty_static) */
/**
* The **`CSS.registerProperty()`** static method registers custom properties, allowing for property type checking, default values, and properties that do or do not inherit their value.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/registerProperty_static)
*/
function registerProperty(definition: PropertyDefinition): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
function rem(value: number): CSSUnitValue;
Expand All @@ -37522,7 +37534,11 @@ declare namespace CSS {
function rlh(value: number): CSSUnitValue;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
function s(value: number): CSSUnitValue;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/supports_static) */
/**
* The **`CSS.supports()`** static method returns a boolean value indicating if the browser supports a given CSS feature, or not.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/supports_static)
*/
function supports(property: string, value: string): boolean;
function supports(conditionText: string): boolean;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSS/factory_functions_static) */
Expand Down Expand Up @@ -37719,44 +37735,120 @@ declare namespace WebAssembly {
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console)
*/
interface Console {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert_static) */
/**
* The **`console.assert()`** static method writes an error message to the console if the assertion is false.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert_static)
*/
assert(condition?: boolean, ...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static) */
/**
* The **`console.clear()`** static method clears the console if possible.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static)
*/
clear(): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static) */
/**
* The **`console.count()`** static method logs the number of times that this particular call to `count()` has been called.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static)
*/
count(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static) */
/**
* The **`console.countReset()`** static method resets counter used with console/count_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static)
*/
countReset(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static) */
/**
* The **`console.debug()`** static method outputs a message to the console at the 'debug' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static)
*/
debug(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static) */
/**
* The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static)
*/
dir(item?: any, options?: any): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static) */
/**
* The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static)
*/
dirxml(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static) */
/**
* The **`console.error()`** static method outputs a message to the console at the 'error' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static)
*/
error(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static) */
/**
* The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console/groupEnd_static is called.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static)
*/
group(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static) */
/**
* The **`console.groupCollapsed()`** static method creates a new inline group in the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static)
*/
groupCollapsed(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static) */
/**
* The **`console.groupEnd()`** static method exits the current inline group in the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static)
*/
groupEnd(): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static) */
/**
* The **`console.info()`** static method outputs a message to the console at the 'info' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static)
*/
info(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static) */
/**
* The **`console.log()`** static method outputs a message to the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static)
*/
log(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static) */
/**
* The **`console.table()`** static method displays tabular data as a table.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static)
*/
table(tabularData?: any, properties?: string[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static) */
/**
* The **`console.time()`** static method starts a timer you can use to track how long an operation takes.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static)
*/
time(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static) */
/**
* The **`console.timeEnd()`** static method stops a timer that was previously started by calling console/time_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static)
*/
timeEnd(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static) */
/**
* The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console/time_static.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static)
*/
timeLog(label?: string, ...data: any[]): void;
timeStamp(label?: string): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static) */
/**
* The **`console.trace()`** static method outputs a stack trace to the console.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static)
*/
trace(...data: any[]): void;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static) */
/**
* The **`console.warn()`** static method outputs a warning message to the console at the 'warning' log level.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static)
*/
warn(...data: any[]): void;
}

Expand Down
Loading
Loading