Ensure all getters are documented

playcanvas · Jun 12, 2024 · ce5117e · ce5117e
1 parent 4cb88f7
commit ce5117e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/src/history.js b/src/history.js
@@ -119,27 +119,37 @@ class History extends Events {
     }
 
     /**
-     * Whether there are any actions to undo
+     * Sets whether there are actions to undo.
      *
      * @type {boolean}
      */
     set canUndo(value) {
         this._history.canUndo = value;
     }
 
+    /**
+     * Gets whether there are actions to undo.
+     *
+     * @type {boolean}
+     */
     get canUndo() {
         return this._history.canUndo;
     }
 
     /**
-     * Whether there are actions to redo
+     * Sets whether there are actions to redo.
      *
      * @type {boolean}
      */
     set canRedo(value) {
         this._history.canRedo = value;
     }
 
+    /**
+     * Gets whether there are actions to redo.
+     *
+     * @type {boolean}
+     */
     get canRedo() {
         return this._history.canRedo;
     }

diff --git a/src/selection.js b/src/selection.js
@@ -18,14 +18,19 @@ class SelectionHistory {
     }
 
     /**
-     * Disables / enables selection undo / redo
+     * Sets enabled state of selection undo / redo.
      *
      * @type {boolean}
      */
     set enabled(value) {
         this._enabled = value;
     }
 
+    /**
+     * Gets enabled state of selection undo / redo.
+     *
+     * @type {boolean}
+     */
     get enabled() {
         return this._enabled;
     }
@@ -323,14 +328,19 @@ class Selection extends Events {
     }
 
     /**
-     * Enables / disables the selection methods
+     * Sets enabled state of the selection methods.
      *
      * @type {boolean}
      */
     set enabled(value) {
         this._enabled = value;
     }
 
+    /**
+     * Gets enabled state of the selection methods.
+     *
+     * @type {boolean}
+     */
     get enabled() {
         return this._enabled;
     }