From c00588537142ca375e7553bea64063d99ccb8e82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Fri, 12 Apr 2024 09:50:09 +0200 Subject: [PATCH 1/2] Align typedoc config with JupyterLab --- .licenserc.yaml | 1 - package.json | 4 +- packages/algorithm/package.json | 4 -- packages/algorithm/typedoc.json | 6 +++ packages/application/package.json | 4 -- packages/application/typedoc.json | 6 +++ packages/collections/package.json | 4 -- packages/collections/typedoc.json | 6 +++ packages/commands/package.json | 4 -- packages/commands/typedoc.json | 6 +++ packages/coreutils/package.json | 4 -- packages/coreutils/typedoc.json | 6 +++ packages/datagrid/package.json | 4 -- packages/datagrid/typedoc.json | 6 +++ packages/disposable/package.json | 4 -- packages/disposable/typedoc.json | 6 +++ packages/domutils/package.json | 4 -- packages/domutils/typedoc.json | 6 +++ packages/dragdrop/package.json | 4 -- packages/dragdrop/typedoc.json | 6 +++ packages/keyboard/package.json | 4 -- packages/keyboard/typedoc.json | 6 +++ packages/messaging/package.json | 4 -- packages/messaging/typedoc.json | 6 +++ packages/polling/package.json | 4 -- packages/polling/typedoc.json | 6 +++ packages/properties/package.json | 4 -- packages/properties/typedoc.json | 6 +++ packages/signaling/package.json | 4 -- packages/signaling/typedoc.json | 6 +++ packages/virtualdom/package.json | 4 -- packages/virtualdom/typedoc.json | 6 +++ packages/widgets/package.json | 4 -- packages/widgets/typedoc.json | 6 +++ tsconfig.docs.json | 11 ----- typedoc-theme/partials/header.hbs | 71 ------------------------------- typedoc.base.json | 4 ++ typedoc.js | 44 +++++++++---------- yarn.lock | 45 ++++++++++++-------- 39 files changed, 148 insertions(+), 192 deletions(-) create mode 100644 packages/algorithm/typedoc.json create mode 100644 packages/application/typedoc.json create mode 100644 packages/collections/typedoc.json create mode 100644 packages/commands/typedoc.json create mode 100644 packages/coreutils/typedoc.json create mode 100644 packages/datagrid/typedoc.json create mode 100644 packages/disposable/typedoc.json create mode 100644 packages/domutils/typedoc.json create mode 100644 packages/dragdrop/typedoc.json create mode 100644 packages/keyboard/typedoc.json create mode 100644 packages/messaging/typedoc.json create mode 100644 packages/polling/typedoc.json create mode 100644 packages/properties/typedoc.json create mode 100644 packages/signaling/typedoc.json create mode 100644 packages/virtualdom/typedoc.json create mode 100644 packages/widgets/typedoc.json delete mode 100644 tsconfig.docs.json delete mode 100644 typedoc-theme/partials/header.hbs create mode 100644 typedoc.base.json diff --git a/.licenserc.yaml b/.licenserc.yaml index 8b71ff579..9f01fa0c9 100644 --- a/.licenserc.yaml +++ b/.licenserc.yaml @@ -25,7 +25,6 @@ header: - 'binder/postBuild' - 'binder/start' - 'CNAME' - - 'typedoc-theme' - 'LICENSE' - 'yarn.lock' diff --git a/package.json b/package.json index 37bdc28a4..03205615d 100644 --- a/package.json +++ b/package.json @@ -55,8 +55,8 @@ "lint-staged": "^13.1.0", "prettier": "^3.0.0", "shell-quote": "^1.7.2", - "typedoc": "^0.24.8", - "typedoc-plugin-mdn-links": "^3.0.3", + "typedoc": "^0.25.13", + "typedoc-plugin-mdn-links": "^3.1.20", "typescript": "~5.1.3" }, "jupyter-releaser": { diff --git a/packages/algorithm/package.json b/packages/algorithm/package.json index 5dbb60c27..f5c1407c0 100644 --- a/packages/algorithm/package.json +++ b/packages/algorithm/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "algorithm" - }, "devDependencies": { "@lumino/buildutils": "^2.0.1", "@microsoft/api-extractor": "^7.36.0", diff --git a/packages/algorithm/typedoc.json b/packages/algorithm/typedoc.json new file mode 100644 index 000000000..4f96cfdde --- /dev/null +++ b/packages/algorithm/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "algorithm", + "readme": "none" +} diff --git a/packages/application/package.json b/packages/application/package.json index 65d033a1b..2883c1b9f 100644 --- a/packages/application/package.json +++ b/packages/application/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "application" - }, "dependencies": { "@lumino/commands": "^2.3.0", "@lumino/coreutils": "^2.1.2", diff --git a/packages/application/typedoc.json b/packages/application/typedoc.json new file mode 100644 index 000000000..ac6d78d59 --- /dev/null +++ b/packages/application/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "application", + "readme": "none" +} diff --git a/packages/collections/package.json b/packages/collections/package.json index 3c4e0a514..04dce030a 100644 --- a/packages/collections/package.json +++ b/packages/collections/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "collections" - }, "dependencies": { "@lumino/algorithm": "^2.0.1" }, diff --git a/packages/collections/typedoc.json b/packages/collections/typedoc.json new file mode 100644 index 000000000..4c4efbcf4 --- /dev/null +++ b/packages/collections/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "collections", + "readme": "none" +} diff --git a/packages/commands/package.json b/packages/commands/package.json index 7d36e7b6b..d16a21ca4 100644 --- a/packages/commands/package.json +++ b/packages/commands/package.json @@ -46,10 +46,6 @@ "test:nobrowser": "cd tests && karma start", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "commands" - }, "dependencies": { "@lumino/algorithm": "^2.0.1", "@lumino/coreutils": "^2.1.2", diff --git a/packages/commands/typedoc.json b/packages/commands/typedoc.json new file mode 100644 index 000000000..da9f64606 --- /dev/null +++ b/packages/commands/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "commands", + "readme": "none" +} diff --git a/packages/coreutils/package.json b/packages/coreutils/package.json index 7016e6a78..55d9ded3b 100644 --- a/packages/coreutils/package.json +++ b/packages/coreutils/package.json @@ -41,10 +41,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "coreutils" - }, "devDependencies": { "@lumino/buildutils": "^2.0.1", "@microsoft/api-extractor": "^7.36.0", diff --git a/packages/coreutils/typedoc.json b/packages/coreutils/typedoc.json new file mode 100644 index 000000000..edb22050d --- /dev/null +++ b/packages/coreutils/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "coreutils", + "readme": "none" +} diff --git a/packages/datagrid/package.json b/packages/datagrid/package.json index 38086ff18..8894a5269 100644 --- a/packages/datagrid/package.json +++ b/packages/datagrid/package.json @@ -46,10 +46,6 @@ "test:nobrowser": "cd tests && karma start", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "datagrid" - }, "dependencies": { "@lumino/algorithm": "^2.0.1", "@lumino/coreutils": "^2.1.2", diff --git a/packages/datagrid/typedoc.json b/packages/datagrid/typedoc.json new file mode 100644 index 000000000..4b6b5175d --- /dev/null +++ b/packages/datagrid/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "datagrid", + "readme": "none" +} diff --git a/packages/disposable/package.json b/packages/disposable/package.json index 431040e4d..55518b5b7 100644 --- a/packages/disposable/package.json +++ b/packages/disposable/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "disposable" - }, "dependencies": { "@lumino/signaling": "^2.1.2" }, diff --git a/packages/disposable/typedoc.json b/packages/disposable/typedoc.json new file mode 100644 index 000000000..bb2211e70 --- /dev/null +++ b/packages/disposable/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "disposable", + "readme": "none" +} diff --git a/packages/domutils/package.json b/packages/domutils/package.json index 9c880c012..c62e18e97 100644 --- a/packages/domutils/package.json +++ b/packages/domutils/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "domutils" - }, "devDependencies": { "@lumino/buildutils": "^2.0.1", "@microsoft/api-extractor": "^7.36.0", diff --git a/packages/domutils/typedoc.json b/packages/domutils/typedoc.json new file mode 100644 index 000000000..ede87eb3d --- /dev/null +++ b/packages/domutils/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "domutils", + "readme": "none" +} diff --git a/packages/dragdrop/package.json b/packages/dragdrop/package.json index b442c9084..54269bca3 100644 --- a/packages/dragdrop/package.json +++ b/packages/dragdrop/package.json @@ -42,10 +42,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "dragdrop" - }, "dependencies": { "@lumino/coreutils": "^2.1.2", "@lumino/disposable": "^2.1.2" diff --git a/packages/dragdrop/typedoc.json b/packages/dragdrop/typedoc.json new file mode 100644 index 000000000..7670d9294 --- /dev/null +++ b/packages/dragdrop/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "dragdrop", + "readme": "none" +} diff --git a/packages/keyboard/package.json b/packages/keyboard/package.json index cb8768e57..6c7458a4e 100644 --- a/packages/keyboard/package.json +++ b/packages/keyboard/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "keyboard" - }, "devDependencies": { "@lumino/buildutils": "^2.0.1", "@microsoft/api-extractor": "^7.36.0", diff --git a/packages/keyboard/typedoc.json b/packages/keyboard/typedoc.json new file mode 100644 index 000000000..7cfd9f39d --- /dev/null +++ b/packages/keyboard/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "keyboard", + "readme": "none" +} diff --git a/packages/messaging/package.json b/packages/messaging/package.json index ea4d5645c..431f7c35a 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "messaging" - }, "dependencies": { "@lumino/algorithm": "^2.0.1", "@lumino/collections": "^2.0.1" diff --git a/packages/messaging/typedoc.json b/packages/messaging/typedoc.json new file mode 100644 index 000000000..14ca75840 --- /dev/null +++ b/packages/messaging/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "messaging", + "readme": "none" +} diff --git a/packages/polling/package.json b/packages/polling/package.json index 4cf6df95f..0a4d3c44c 100644 --- a/packages/polling/package.json +++ b/packages/polling/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "polling" - }, "dependencies": { "@lumino/coreutils": "^2.1.2", "@lumino/disposable": "^2.1.2", diff --git a/packages/polling/typedoc.json b/packages/polling/typedoc.json new file mode 100644 index 000000000..a9e9bec28 --- /dev/null +++ b/packages/polling/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "polling", + "readme": "none" +} diff --git a/packages/properties/package.json b/packages/properties/package.json index fb2eba260..a360413e3 100644 --- a/packages/properties/package.json +++ b/packages/properties/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "properties" - }, "devDependencies": { "@lumino/buildutils": "^2.0.1", "@microsoft/api-extractor": "^7.36.0", diff --git a/packages/properties/typedoc.json b/packages/properties/typedoc.json new file mode 100644 index 000000000..6b1a6efbd --- /dev/null +++ b/packages/properties/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "properties", + "readme": "none" +} diff --git a/packages/signaling/package.json b/packages/signaling/package.json index f98fa6ad8..0beced89e 100644 --- a/packages/signaling/package.json +++ b/packages/signaling/package.json @@ -39,10 +39,6 @@ "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "signaling" - }, "dependencies": { "@lumino/algorithm": "^2.0.1", "@lumino/coreutils": "^2.1.2" diff --git a/packages/signaling/typedoc.json b/packages/signaling/typedoc.json new file mode 100644 index 000000000..026431372 --- /dev/null +++ b/packages/signaling/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "signaling", + "readme": "none" +} diff --git a/packages/virtualdom/package.json b/packages/virtualdom/package.json index 3e2ad899d..c6e47879a 100644 --- a/packages/virtualdom/package.json +++ b/packages/virtualdom/package.json @@ -46,10 +46,6 @@ "test:nobrowser": "cd tests && karma start", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "virtualdom" - }, "dependencies": { "@lumino/algorithm": "^2.0.1" }, diff --git a/packages/virtualdom/typedoc.json b/packages/virtualdom/typedoc.json new file mode 100644 index 000000000..5dfbd34b9 --- /dev/null +++ b/packages/virtualdom/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "virtualdom", + "readme": "none" +} diff --git a/packages/widgets/package.json b/packages/widgets/package.json index 313830fba..6c2765f10 100644 --- a/packages/widgets/package.json +++ b/packages/widgets/package.json @@ -49,10 +49,6 @@ "test:nobrowser": "cd tests && karma start", "watch": "tsc --build --watch" }, - "typedoc": { - "entryPoint": "./src/index.ts", - "displayName": "widgets" - }, "dependencies": { "@lumino/algorithm": "^2.0.1", "@lumino/commands": "^2.3.0", diff --git a/packages/widgets/typedoc.json b/packages/widgets/typedoc.json new file mode 100644 index 000000000..5b1d59544 --- /dev/null +++ b/packages/widgets/typedoc.json @@ -0,0 +1,6 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"], + "name": "widgets", + "readme": "none" +} diff --git a/tsconfig.docs.json b/tsconfig.docs.json deleted file mode 100644 index 867401cb8..000000000 --- a/tsconfig.docs.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "extends": "./tsconfigbase.json", - "exclude": ["**/tests/**"], - "compilerOptions": { - "lib": ["DOM", "DOM.Iterable", "ES2018"], - "paths": { - "@lumino/*": ["./packages/*/src"] - }, - "types": ["node"] - } -} diff --git a/typedoc-theme/partials/header.hbs b/typedoc-theme/partials/header.hbs deleted file mode 100644 index b2a0fa04d..000000000 --- a/typedoc-theme/partials/header.hbs +++ /dev/null @@ -1,71 +0,0 @@ -
-
-
-
- - -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - {{#unless settings.excludeExternals}} - - - {{/unless}} - - {{#unless settings.excludeNotExported}} - - - {{/unless}} -
-
- - Menu -
-
-
-
-
-
-
    - {{#with model}}{{> breadcrumb}}{{/with}} -
-

{{#compact}} - {{model.kindString}}  - {{model.name}} - {{#if model.typeParameters}} - < - {{#each model.typeParameters}} - {{#if @index}}, {{/if}} - {{name}} - {{/each}} - > - {{/if}} - {{/compact}}

-
-
-
diff --git a/typedoc.base.json b/typedoc.base.json new file mode 100644 index 000000000..daa58cb2e --- /dev/null +++ b/typedoc.base.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "includeVersion": true +} diff --git a/typedoc.js b/typedoc.js index b5852ee46..458023a85 100644 --- a/typedoc.js +++ b/typedoc.js @@ -5,30 +5,25 @@ module.exports = { entryPoints: [ - 'packages/algorithm/src/index.ts', - 'packages/application/src/index.ts', - 'packages/collections/src/index.ts', - 'packages/commands/src/index.ts', - 'packages/coreutils/src/index.ts', - 'packages/datagrid/src/index.ts', - 'packages/disposable/src/index.ts', - 'packages/domutils/src/index.ts', - 'packages/dragdrop/src/index.ts', - 'packages/keyboard/src/index.ts', - 'packages/messaging/src/index.ts', - 'packages/polling/src/index.ts', - 'packages/properties/src/index.ts', - 'packages/signaling/src/index.ts', - 'packages/virtualdom/src/index.ts', - 'packages/widgets/src/index.ts' + 'packages/algorithm', + 'packages/application', + 'packages/collections', + 'packages/commands', + 'packages/coreutils', + 'packages/datagrid', + 'packages/disposable', + 'packages/domutils', + 'packages/dragdrop', + 'packages/keyboard', + 'packages/messaging', + 'packages/polling', + 'packages/properties', + 'packages/signaling', + 'packages/virtualdom', + 'packages/widgets' ], - exclude: [ - 'buildutils', - 'examples/**', - '**/tests/**', - 'packages/default-theme' - ], - includeVersion: true, + entryPointStrategy: 'packages', + includeVersion: false, name: '@lumino', out: 'docs/source/api', readme: 'README.md', @@ -37,6 +32,5 @@ module.exports = { Jupyter: 'https://jupyter.org' }, titleLink: 'https://lumino.readthedocs.io/en/latest/', - plugin: ['typedoc-plugin-mdn-links'], - tsconfig: 'tsconfig.docs.json' + plugin: ['typedoc-plugin-mdn-links'] }; diff --git a/yarn.lock b/yarn.lock index 424dba6e6..2bed2f143 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6908,8 +6908,8 @@ __metadata: lint-staged: ^13.1.0 prettier: ^3.0.0 shell-quote: ^1.7.2 - typedoc: ^0.24.8 - typedoc-plugin-mdn-links: ^3.0.3 + typedoc: ^0.25.13 + typedoc-plugin-mdn-links: ^3.1.20 typescript: ~5.1.3 languageName: unknown linkType: soft @@ -7222,6 +7222,15 @@ __metadata: languageName: node linkType: hard +"minimatch@npm:^9.0.3": + version: 9.0.4 + resolution: "minimatch@npm:9.0.4" + dependencies: + brace-expansion: ^2.0.1 + checksum: cf717f597ec3eed7dabc33153482a2e8d49f4fd3c26e58fd9c71a94c5029a0838728841b93f46bf1263b65a8010e2ee800d0dc9b004ab8ba8b6d1ec07cc115b5 + languageName: node + linkType: hard + "minimist-options@npm:4.1.0": version: 4.1.0 resolution: "minimist-options@npm:4.1.0" @@ -9923,15 +9932,15 @@ __metadata: languageName: node linkType: hard -"shiki@npm:^0.14.1": - version: 0.14.1 - resolution: "shiki@npm:0.14.1" +"shiki@npm:^0.14.7": + version: 0.14.7 + resolution: "shiki@npm:0.14.7" dependencies: ansi-sequence-parser: ^1.1.0 jsonc-parser: ^3.2.0 vscode-oniguruma: ^1.7.0 vscode-textmate: ^8.0.0 - checksum: b19ea337cc84da69d99ca39d109f82946e0c56c11cc4c67b3b91cc14a9479203365fd0c9e0dd87e908f493ab409dc6f1849175384b6ca593ce7da884ae1edca2 + checksum: 2aec3b3519df977c4391df9e1825cb496e9a4d7e11395f05a0da77e4fa2f7c3d9d6e6ee94029ac699533017f2b25637ee68f6d39f05f311535c2704d0329b520 languageName: node linkType: hard @@ -10842,28 +10851,28 @@ __metadata: languageName: node linkType: hard -"typedoc-plugin-mdn-links@npm:^3.0.3": - version: 3.0.3 - resolution: "typedoc-plugin-mdn-links@npm:3.0.3" +"typedoc-plugin-mdn-links@npm:^3.1.20": + version: 3.1.20 + resolution: "typedoc-plugin-mdn-links@npm:3.1.20" peerDependencies: - typedoc: ">= 0.23.14 || 0.24.x" - checksum: 1682f8a65e1eff892f5ae0424919007d0673d9abda7c7f401b294fc73d64ce8fc4e1cbb35e5389170a8c48ed57efe6ee81403f870499c62decb016b689fa6522 + typedoc: ">= 0.23.14 || 0.24.x || 0.25.x" + checksum: 4df7bf176ec2db52a7db5d022136f3b5af9599ddfa91f454d6a06324f73ab4bc054141bef83aba6c6dd311ed2ebc426431e9f1599ed956ecc24285f291b07eeb languageName: node linkType: hard -"typedoc@npm:^0.24.8": - version: 0.24.8 - resolution: "typedoc@npm:0.24.8" +"typedoc@npm:^0.25.13": + version: 0.25.13 + resolution: "typedoc@npm:0.25.13" dependencies: lunr: ^2.3.9 marked: ^4.3.0 - minimatch: ^9.0.0 - shiki: ^0.14.1 + minimatch: ^9.0.3 + shiki: ^0.14.7 peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x bin: typedoc: bin/typedoc - checksum: a46a14497f789fb3594e6c3af2e45276934ac46df40b7ed15a504ee51dc7a8013a2ffb3a54fd73abca6a2b71f97d3ec9ad356fa9aa81d29743e4645a965a2ae0 + checksum: 703d1f48137300b0ef3df1998a25ae745db3ca0b126f8dd1f7262918f11243a94d24dfc916cdba2baeb5a7d85d5a94faac811caf7f4fa6b7d07144dc02f7639f languageName: node linkType: hard From 7b43020200e2ac16c2e5d89fffc03ff29d76c041 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Fri, 12 Apr 2024 10:01:14 +0200 Subject: [PATCH 2/2] Remove some doc warning --- packages/algorithm/src/array.ts | 2 +- packages/keyboard/src/index.ts | 4 ++-- packages/widgets/src/accordionlayout.ts | 2 +- packages/widgets/src/singletonlayout.ts | 2 -- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/packages/algorithm/src/array.ts b/packages/algorithm/src/array.ts index 973d28a4a..e82db0f6a 100644 --- a/packages/algorithm/src/array.ts +++ b/packages/algorithm/src/array.ts @@ -244,7 +244,7 @@ export namespace ArrayExt { /** * Find the index of the last value which matches a predicate. * - * @param object - The array-like object to search. + * @param array - The array-like object to search. * * @param fn - The predicate function to apply to the values. * diff --git a/packages/keyboard/src/index.ts b/packages/keyboard/src/index.ts index 677c3ab7a..7676e77d1 100644 --- a/packages/keyboard/src/index.ts +++ b/packages/keyboard/src/index.ts @@ -85,7 +85,7 @@ export function getKeyboardLayout(): IKeyboardLayout { /** * Set the global application keyboard layout instance. * - * @param - The keyboard layout for use by the application. + * @param layout The keyboard layout for use by the application. * * #### Notes * The keyboard layout should typically be set on application startup @@ -197,7 +197,7 @@ export namespace KeycodeLayout { /** * Extract the set of keys from a code map. * - * @param code - The code map of interest. + * @param codes - The code map of interest. * * @returns A set of the keys in the code map. */ diff --git a/packages/widgets/src/accordionlayout.ts b/packages/widgets/src/accordionlayout.ts index fa2da95dc..19771d2ee 100644 --- a/packages/widgets/src/accordionlayout.ts +++ b/packages/widgets/src/accordionlayout.ts @@ -241,7 +241,7 @@ export namespace AccordionLayout { /** * Render the element for a section title. * - * @param data - The data to use for rendering the section title. + * @param title - The data to use for rendering the section title. * * @returns A element representing the section title. */ diff --git a/packages/widgets/src/singletonlayout.ts b/packages/widgets/src/singletonlayout.ts index fe3322e70..127ebacfb 100644 --- a/packages/widgets/src/singletonlayout.ts +++ b/packages/widgets/src/singletonlayout.ts @@ -126,8 +126,6 @@ export class SingletonLayout extends Layout { /** * Attach a widget to the parent's DOM node. * - * @param index - The current index of the widget in the layout. - * * @param widget - The widget to attach to the parent. * * #### Notes