TSDoc link fixes

xeokit · Mar 15, 2024 · bbcda94 · bbcda94
1 parent ed3bc1c
commit bbcda94
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 16 deletions.
diff --git a/packages/cityjson/src/loadCityJSON.ts b/packages/cityjson/src/loadCityJSON.ts
@@ -28,7 +28,7 @@ const tempVec3c = createVec3();
  * * Expects {@link @xeokit/scene!SceneModel.built | SceneModel.built} and {@link @xeokit/scene!SceneModel.destroyed | SceneModel.destroyed} to be ````false````
  * * Does not call {@link @xeokit/scene!SceneModel.build | SceneModel.build} - we call that ourselves, when we have finished building the SceneModel
  *
- * See {@link "@xeokit/cityjson"} for usage.
+ * See {@link "@xeokit/cityjson" | @xeokit/cityjson} for usage.
  *
  * @param params - Loading parameters.
  * @param params.fileData - CityJSON file data.

diff --git a/packages/dotbim/src/loadDotBIM.ts b/packages/dotbim/src/loadDotBIM.ts
@@ -11,7 +11,7 @@ import {typeCodes} from "@xeokit/ifctypes";
  * * Expects {@link @xeokit/scene!SceneModel.built | SceneModel.built} and {@link @xeokit/scene!SceneModel.destroyed | SceneModel.destroyed} to be ````false````
  * * Does not call {@link @xeokit/scene!SceneModel.build | SceneModel.build} - we call that ourselves, when we have finished building the SceneModel
  *
- * See {@link "@xeokit/dotbim"} for usage.
+ * See {@link "@xeokit/dotbim" | @xeokit/dotbim} for usage.
  *
  * @param params - Loading parameters.
  * @param params.fileData - .BIM file data.

diff --git a/packages/dotbim/src/saveDotBIM.ts b/packages/dotbim/src/saveDotBIM.ts
@@ -12,7 +12,7 @@ const tempVec3b = createVec3();
  * Exports a {@link @xeokit/scene!SceneModel | SceneModel} and/or a {@link @xeokit/data!DataModel} to a JSON object
  * containing .BIM file data.
  *
- * See {@link @xeokit/dotbim} for usage.
+ * See {@link "@xeokit/dotbim" | @xeokit/dotbim} for usage.
  *
  * @param params
  * @param params.model - The SceneModel to export to .BIM.
@@ -181,4 +181,4 @@ function modelToDotBIM(params: { dataModel: DataModel; sceneModel: SceneModel })
     }
 
     return dotBim;
-}
+}
diff --git a/packages/dtx/src/DTX_INFO.ts b/packages/dtx/src/DTX_INFO.ts
@@ -1,7 +1,7 @@
 /**
  * Provides info on the [DTX](https://xeokit.github.io/sdk/docs/pages/GLOSSARY.html#dtx) generated by {@link @xeokit/dtx!saveDTX}.
  *
- * See {@link "@xeokit/dtx"} for usage.
+ * See {@link "@xeokit/dtx" | @xeokit/dtx} for usage.
  */
 export const DTX_INFO = {
 
@@ -12,4 +12,4 @@ export const DTX_INFO = {
      * @type {number}
      */
     dtxVersion: 1
-};
+};
diff --git a/packages/dtx/src/loadDTX.ts b/packages/dtx/src/loadDTX.ts
@@ -14,7 +14,7 @@ import {dtxToModel} from "./dtxToModel";
  * * Expects {@link @xeokit/data!DataModel.built | DataModel.built} and
  * {@link @xeokit/data!DataModel.destroyed | DataModel.destroyed} to be ````false````
  *
- * See {@link "@xeokit/dtx"} for usage.
+ * See {@link "@xeokit/dtx" | @xeokit/dtx} for usage.
  *
  * See {@link @xeokit/dtx!DTXData} for insights into the structure of a [DTX](https://xeokit.github.io/sdk/docs/pages/GLOSSARY.html#dtx) file.
  *
@@ -55,4 +55,4 @@ export function loadDTX(params: {
         dataModel,
     });
     return Promise.resolve();
-}
+}
diff --git a/packages/dtx/src/saveDTX.ts b/packages/dtx/src/saveDTX.ts
@@ -9,7 +9,7 @@ import {packDTX} from "./packDTX";
  * Exports a {@link @xeokit/scene!SceneModel | SceneModel} and/or a {@link @xeokit/data!DataModel | DataModel} to an ArrayBuffer
  * containing [DTX](https://xeokit.github.io/sdk/docs/pages/GLOSSARY.html#dtx) file data.
  *
- * See {@link "@xeokit/dtx"} for usage.
+ * See {@link "@xeokit/dtx" | @xeokit/dtx} for usage.
  *
  * See {@link @xeokit/dtx!DTXData} for insights into the structure of a [DTX](https://xeokit.github.io/sdk/docs/pages/GLOSSARY.html#dtx) file.
  *
@@ -44,4 +44,4 @@ export function saveDTX(params: {
         sceneModel: params.sceneModel,
         dataModel: params.dataModel
     })));
-}
+}
diff --git a/packages/gltf/src/loadGLTF.ts b/packages/gltf/src/loadGLTF.ts
@@ -40,7 +40,7 @@ interface ParsingContext {
  * * Expects {@link @xeokit/scene!SceneModel.built | SceneModel.built} and {@link @xeokit/scene!SceneModel.destroyed | SceneModel.destroyed} to be ````false````
  * * Does not call {@link @xeokit/scene!SceneModel.build | SceneModel.build} - we call that ourselves, when we have finished building the SceneModel
  *
- * See {@link @xeokit/gltf} for usage.
+ * See {@link "@xeokit/gltf" | @xeokit/gltf} for usage.
  *
  * @param params - Loading parameters.
  * @param params.fileData - glTF file data

diff --git a/packages/viewer/src/View.ts b/packages/viewer/src/View.ts
@@ -34,7 +34,7 @@ import {ResolutionScale} from "./ResolutionScale";
 /**
  * An independently-configurable view of the models in a {@link @xeokit/viewer!Viewer}.
  *
- * See {@link @xeokit/viewer} for usage.
+ * See {@link "@xeokit/viewer" | @xeokit/viewer} for usage.
  *
  * ## Overview
  *

diff --git a/packages/viewer/src/Viewer.ts b/packages/viewer/src/Viewer.ts
@@ -15,7 +15,7 @@ import type {TickParams} from "./TickParams";
 /**
  * A Browser-based 2D/3D model viewer.
  *
- * See {@link @xeokit/viewer} for usage.
+ * See {@link "@xeokit/viewer" | @xeokit/viewer} for usage.
  */
 export class Viewer extends Component {
 

diff --git a/packages/webglrenderer/src/WebGLRenderer.ts b/packages/webglrenderer/src/WebGLRenderer.ts
@@ -22,7 +22,7 @@ const isSafari = (ua && ua[1].toLowerCase() === "safari");
 /**
  * A WebGL-based rendering strategy for a {@link @xeokit/viewer!Viewer | Viewer}.
  *
- * See {@link @xeokit/webglrenderer} for usage.
+ * See {@link "@xeokit/webglrenderer" | @xeokit/webglrenderer} for usage.
  */
 export class WebGLRenderer implements Renderer {
 

diff --git a/packages/webifc/src/loadWebIFC.ts b/packages/webifc/src/loadWebIFC.ts
@@ -28,7 +28,7 @@ interface ParsingContext {
  * * Expects {@link @xeokit/scene!SceneModel.built | SceneModel.built} and {@link @xeokit/scene!SceneModel.destroyed | SceneModel.destroyed} to be ````false````
  * * Does not call {@link @xeokit/scene!SceneModel.build | SceneModel.build} - we call that ourselves, when we have finished building the SceneModel
  *
- * See {@link @xeokit/webifc} for usage.
+ * See {@link "@xeokit/webifc" | @xeokit/webifc} for usage.
  *
  * @param params - Loading parameters.
  * @param params.fileData - IFC file contents.
@@ -263,4 +263,4 @@ function parseSceneModel(ctx: ParsingContext) {
             meshIds: meshIds
         });
     });
-}
+}