docs: update typedoc configuration (#4)

amzn · Dec 23, 2024 · b3e1f69 · b3e1f69
1 parent 98ebd08
commit b3e1f69
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "build": "rimraf dist && npm run lint && tsc -b tsconfig.json && npm run copy-files",
     "clean": "rimraf node_modules dist coverage docs",
     "copy-files": "cpy public/* package.json LICENSE README.md THIRD_PARTY_LICENSES dist",
-    "docs": "typedoc src/index.ts",
+    "docs": "typedoc",
     "format": "eslint '**/*.{ts,tsx}' --fix",
     "lint": "eslint '**/*.{ts,tsx}' --quiet",
     "pack:dist": "npm run build && npm run test && npm run docs && cd dist && npm pack && cd ..",

diff --git a/src/config/cameraConfig.ts b/src/config/cameraConfig.ts
@@ -97,7 +97,7 @@ export interface CameraBaseProperty {
 
     /**
      * The Camera Animation Configuration groups the different settings used to define the camera animation behavior
-     * @default {@link DEFAULT_CAMERA_ANIMATION_CONFIG}
+     * @default {@link config/cameraAnimationConfig.DEFAULT_CAMERA_ANIMATION_CONFIG}
      */
     cameraAnimationConfig?: CameraAnimationConfig;
 

diff --git a/src/scene/abstractScene.ts b/src/scene/abstractScene.ts
@@ -265,7 +265,7 @@ export abstract class AbstractScene implements IDisposable {
 
     /**
      * Turn on/off a specific lighting rig
-     * @param lightingName - the name of lighting, i.e. the key in {@link LightingConfig}
+     * @param lightingName - the name of lighting, i.e. the key in {@link Config.lightingConfig}
      * @param visible - force the lighting to be visible or invisible
      */
     public toggleLighting(lightingName: string, visible?: boolean): void {

diff --git a/tsconfig.json b/tsconfig.json
@@ -29,10 +29,13 @@
       "es2015.symbol.wellknown"
     ],
     "outDir": "./dist",
-    "rootDir": "./src",
+    "rootDir": "./src"
   },
   "typedocOptions": {
-    "entryPoints": ["src/index.ts"],
+    "entryPoints": ["src"],
+    "entryPointStrategy": "expand",
+    "exclude": "**/*+(index|.d).ts",
+    "excludeReferences": true,
     "out": "docs"
   },
   "include": ["./src/**/*"],