Continue documenting Ace API

This commit is contained in:
Garen Torikian 2012-03-21 16:48:40 +01:00
commit e249ddd118
12 changed files with 181 additions and 151 deletions

View file

@ -43,7 +43,7 @@ define(function(require, exports, module) {
/**
* class UndoManager
*
* This object controls all the undoing that needs to be done. TODO
* This object maintains the undo stack for an [[EditSession `EditSession`]].
*
**/
@ -60,9 +60,12 @@ var UndoManager = function() {
/**
* UndoManager.execute(options) -> Void
* - options (Object):
* - options (Object): Contains additional properties
*
* Provides a means for implementing your own undo manager. `options` has one property, `args`, an [[Array `Array`]], with two elements:
* * `args[0]` is an array of deltas
* * `args[1]` is the document to associate with
*
* TODO
**/
this.execute = function(options) {
var deltas = options.args[0];
@ -73,7 +76,7 @@ var UndoManager = function() {
/**
* UndoManager.undo(dontSelect) -> Range
* - dontSelect (Boolean): TODO
* - dontSelect (Boolean): {:dontSelect}
*
* [Perform an undo operation on the document, reverting the last change. Returns the range of the undo.]{: #UndoManager.undo}
**/
@ -90,7 +93,7 @@ var UndoManager = function() {
/**
* UndoManager.redo(dontSelect) -> Void
* - dontSelect (Boolean): TODO
* - dontSelect (Boolean): {:dontSelect}
*
* [Perform a redo operation on the document, reimplementing the last change.]{: #UndoManager.redo}
**/