docs: refactor comments

galacean · Feb 21, 2023 · 090d4ab · 090d4ab
1 parent 7e690c3
commit 090d4ab
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/packages/math/src/Color.ts b/packages/math/src/Color.ts
@@ -305,8 +305,8 @@ export class Color implements IClone<Color>, ICopy<ColorLike, Color> {
   }
 
   /**
-   * json serialization.
-   * return {r: number, g: number, b: number, a: number}
+   * JSON serialization.
+   * @return A JSON representation of this color
    */
   toJSON(): ColorLike {
     return {

diff --git a/packages/math/src/Quaternion.ts b/packages/math/src/Quaternion.ts
@@ -759,7 +759,7 @@ export class Quaternion implements IClone<Quaternion>, ICopy<QuaternionLike, Qua
 
   /**
    * JSON JSON serialization.
-   * @returns A string representation of this vector
+   * @returns A JSON Object representation of this quaternion
    */
   toJSON(): QuaternionLike {
     return {

diff --git a/packages/math/src/Vector2.ts b/packages/math/src/Vector2.ts
@@ -377,7 +377,7 @@ export class Vector2 implements IClone<Vector2>, ICopy<Vector2Like, Vector2> {
 
   /**
    * JSON serialization.
-   * @returns A string representation of this vector
+   * @returns A JSON representation of this vector
    */
   toJSON(): Vector2Like {
     return {

diff --git a/packages/math/src/Vector4.ts b/packages/math/src/Vector4.ts
@@ -506,7 +506,7 @@ export class Vector4 implements IClone<Vector4>, ICopy<Vector4Like, Vector4> {
 
   /**
    * JSON serialization.
-   * @returns A string representation of this vector
+   * @returns A JSON representation of this vector
    */
   toJSON(): Vector4Like {
     return {