Skip to content

Commit

Permalink
Tweak docs for HistoryAction
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott committed Jun 15, 2024
1 parent db5dd8d commit 199b6f1
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions src/history.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import Events from './events.js';

/**
* @name HistoryAction
* @class
* @classdesc A history action
* @property {string} name The name of the action
* @property {Function} undo The undo function
* @property {Function} redo The redo function
* @property {boolean} combine Whether to combine with the previous action with the same name.
* The effect of combining is merely changing the redo function to be the redo function of this action.
* @typedef {object} HistoryAction
* @property {string} name - The action name.
* @property {Function} undo - The undo function.
* @property {Function} redo - The redo function.
* @property {boolean} combine Whether to combine with the previous action with the same name. The
* effect of combining is merely changing the redo function to be the redo function of this action.
* The original undo function is not modified.
*/

Expand Down

0 comments on commit 199b6f1

Please sign in to comment.