Align typedoc config with JupyterLab (#696)

fcollonval · web-flow · commit f9b76e2ca964 · 2024-04-12T10:31:06.000+01:00
* Align typedoc config with JupyterLab

* Remove some doc warning

---------

Co-authored-by: Frédéric Collonval &lt;fcollonval@users.noreply.github.com&gt;
diff --git 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
@@ -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
@@ -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/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/algorithm/typedoc.json 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/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/keyboard/typedoc.json 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/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
@@ -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
diff --git a/packages/widgets/typedoc.json 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
diff --git a/typedoc-theme/partials/header.hbs b/typedoc-theme/partials/header.hbs
diff --git a/typedoc.base.json b/typedoc.base.json
diff --git a/typedoc.js b/typedoc.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ export namespace ArrayExt {`
`244`	`244`	`/**`
`245`	`245`	`* Find the index of the last value which matches a predicate.`
`246`	`246`	`*`
`247`		`- * @param object - The array-like object to search.`
	`247`	`+ * @param array - The array-like object to search.`
`248`	`248`	`*`
`249`	`249`	`* @param fn - The predicate function to apply to the values.`
`250`	`250`	`*`