docs: update jsdoc comments

hiloteam · Apr 3, 2023 · fc1749d · fc1749d
1 parent 6f8d76b
commit fc1749d
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 19 deletions.
diff --git a/src/math/EulerNotifier.js b/src/math/EulerNotifier.js
@@ -6,7 +6,7 @@ const DEG2RAD = math.DEG2RAD;
 const RAD2DEG = math.RAD2DEG;
 
 /**
- * 欧拉角, 数据改变会发送事件
+ * 欧拉角，具有 onUpdate 回调
  * @class
  * @extends Euler
  */

diff --git a/src/math/Matrix4.js b/src/math/Matrix4.js
@@ -576,7 +576,7 @@ const Matrix4 = Class.create(/** @lends Matrix4.prototype */ {
      * @param  {Quaternion} q quaternion
      * @param  {Vector3} v position
      * @param  {Vector3} s scale
-     * @param  {Vector3} p [pivot]
+     * @param  {Vector3} [p] pivot
      * @return {Matrix4}  this
      */
     compose(q, v, s, p) {

diff --git a/src/math/Matrix4Notifier.js b/src/math/Matrix4Notifier.js
@@ -11,7 +11,7 @@ const tempVector3 = new Vector3();
 const tempVector32 = new Vector3();
 
 /**
- * 4x4 矩阵, 数据改变会发送事件
+ * 4x4 矩阵，具有 onUpdate 回调
  * @class
  * @extends {Matrix4}
  */

diff --git a/src/math/QuaternionNotifier.js b/src/math/QuaternionNotifier.js
@@ -7,28 +7,34 @@ import Class from '../core/Class';
 const tempMat3 = new Matrix3();
 
 /**
+ * 四元数，具有 onUpdate 回调
  * @class
  */
-const QuaternionNotifier = Class.create(/** @lends Quaternion.prototype */ {
+const QuaternionNotifier = Class.create(/** @lends QuaternionNotifier.prototype */ {
     /**
-   * 类名
-   * @type {String}
-  * @default QuaternionNotifier
-   */
+     * 类名
+     * @type {String}
+     * @default QuaternionNotifier
+     */
     className: 'QuaternionNotifier',
     /**
-   * @type {Boolean}
-   * @default true
-   */
+     * @type {Boolean}
+     * @default true
+     */
     isQuaternionNotifier: true,
     /**
-   * Creates a new identity quat
-   * @constructs
-   * @param  {Number} [x=0] X component
-   * @param  {Number} [y=0] Y component
-   * @param  {Number} [z=0] Z component
-   * @param  {Number} [w=1] W component
-   */
+     * @type {Boolean}
+     * @default true
+     */
+    isQuaternion: true,
+    /**
+     * Creates a new identity quat
+     * @constructs
+     * @param  {Number} [x=0] X component
+     * @param  {Number} [y=0] Y component
+     * @param  {Number} [z=0] Z component
+     * @param  {Number} [w=1] W component
+    */
     constructor(x = 0, y = 0, z = 0, w = 1) {
     /**
      * 数据

diff --git a/src/math/Vector3Notifier.js b/src/math/Vector3Notifier.js
@@ -5,7 +5,7 @@ import Class from '../core/Class';
 import Vector3 from './Vector3';
 
 /**
- * 三维向量, 数据改变会发送事件
+ * 三维向量，具有 onUpdate 回调
  * @class
  * @extends Vector3
  */

diff --git a/src/math/index.js b/src/math/index.js
@@ -7,6 +7,7 @@ export { default as Matrix3 } from './Matrix3';
 export { default as Matrix4 } from './Matrix4';
 export { default as Matrix4Notifier } from './Matrix4Notifier';
 export { default as Plane } from './Plane';
+export { default as QuaternionNotifier } from './QuaternionNotifier';
 export { default as Quaternion } from './Quaternion';
 export { default as Ray } from './Ray';
 export { default as Sphere } from './Sphere';