doc: minor update on Controls documentation

iTowns · Sep 15, 2021 · 5f4ace1 · 5f4ace1
1 parent 76130b4
commit 5f4ace1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/src/Controls/GlobeControls.js b/src/Controls/GlobeControls.js
@@ -154,7 +154,6 @@ let previous;
  * @param      {number}  options.minDistance Minimum distance between ground and camera
  * @param      {number}  options.maxDistance Maximum distance between ground and camera
  * @param      {bool}  options.handleCollision enable collision camera with ground
- * @property   {bool} enabled enable control
  * @property   {number} minDistance Minimum distance between ground and camera
  * @property   {number} maxDistance Maximum distance between ground and camera
  * @property   {number} zoomSpeed Speed zoom with mouse

diff --git a/src/Controls/StateControl.js b/src/Controls/StateControl.js
@@ -118,6 +118,8 @@ function stateToTrigger(state) {
                                     * a given position. The target position depends on the key/mouse binding of this
                                     * state. If bound to a mouse button, the target position is the mouse position.
                                     * Otherwise, it is the center of the screen. It is disabled by default.
+ * @property {boolean}  enable      Defines whether all input will be communicated to the associated `Controls` or not.
+                                    * Default is true.
  */
 class StateControl extends THREE.EventDispatcher {
     constructor(view, options = {}) {