chore: update tsdocs and API file

cognitedata · Jul 17, 2024 · b4a1cce · b4a1cce
1 parent 4f9a853
commit b4a1cce
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/viewer/packages/camera-manager/src/CameraManagerHelper.ts b/viewer/packages/camera-manager/src/CameraManagerHelper.ts
@@ -113,8 +113,6 @@ export class CameraManagerHelper {
    * Updates near and far plane of the camera based on the bounding box.
    * @param camera Used camera instance.
    * @param boundingBox Bounding box of all objects on the scene.
-   * @param nearAndFarPlaneBuffers to read from
-   * @param cameraFarBuffers
    * @deprecated use instance method instead
    */
   static updateCameraNearAndFar(camera: PerspectiveCamera, boundingBox: Box3): void {
@@ -126,6 +124,11 @@ export class CameraManagerHelper {
     );
   }
 
+  /**
+   * Updates near and far plane of the camera based on the bounding box.
+   * @param camera Used camera instance.
+   * @param boundingBox Bounding box of all objects on the scene.
+   */
   public updateCameraNearAndFar(camera: PerspectiveCamera, boundingBox: Box3): void {
     CameraManagerHelper.updateCameraNearAndFarInternal(
       camera,

diff --git a/viewer/reveal.api.md b/viewer/reveal.api.md
@@ -333,7 +333,9 @@ export class CameraManagerHelper {
     };
     static calculateNewRotationFromTarget(camera: PerspectiveCamera, newTarget: Vector3): Quaternion;
     static calculateNewTargetFromRotation(camera: PerspectiveCamera, rotation: Quaternion, currentTarget: Vector3, position: Vector3): Vector3;
+    // @deprecated
     static updateCameraNearAndFar(camera: PerspectiveCamera, boundingBox: Box3): void;
+    updateCameraNearAndFar(camera: PerspectiveCamera, boundingBox: Box3): void;
 }
 
 // @public (undocumented)