undomanager.js in gollum-2.4.5

- old
+ new

@@ -1,86 +1,80 @@
-/* vim:ts=4:sts=4:sw=4:
- * ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+/* ***** BEGIN LICENSE BLOCK *****
+ * Distributed under the BSD license:
  *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Ajax.org Code Editor (ACE).
- *
- * The Initial Developer of the Original Code is
- * Ajax.org B.V.
- * Portions created by the Initial Developer are Copyright (C) 2010
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *      Fabian Jakobs <fabian AT ajax DOT org>
- *      Mihai Sucan <mihai DOT sucan AT gmail DOT com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
  * ***** END LICENSE BLOCK ***** */
 
 define(function(require, exports, module) {
 "use strict";
 
 /**
- * class UndoManager
+ * 
  *
  * This object maintains the undo stack for an [[EditSession `EditSession`]].
- *
+ * @class UndoManager
  **/
 
 /**
- * new UndoManager()
  * 
+ * 
  * Resets the current undo state and creates a new `UndoManager`.
+ * 
+ * @constructor
  **/
 var UndoManager = function() {
     this.reset();
 };
 
 (function() {
 
     /**
-    * UndoManager.execute(options) -> Void
-    * - 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
     *
+    * - `args[0]` is an array of deltas
+    * - `args[1]` is the document to associate with
+    *
+    * @param {Object} options Contains additional properties
+    *
     **/
     this.execute = function(options) {
         var deltas = options.args[0];
         this.$doc  = options.args[1];
         this.$undoStack.push(deltas);
         this.$redoStack = [];
     };
 
     /**
-    * UndoManager.undo(dontSelect) -> Range
-    * - dontSelect (Boolean): {:dontSelect}
+    * [Perform an undo operation on the document, reverting the last change.]{: #UndoManager.undo}
+    * @param {Boolean} dontSelect {:dontSelect}
     *
-    * [Perform an undo operation on the document, reverting the last change. Returns the range of the undo.]{: #UndoManager.undo}
+    * 
+    * @returns {Range} The range of the undo.
     **/
     this.undo = function(dontSelect) {
         var deltas = this.$undoStack.pop();
         var undoSelectionRange = null;
         if (deltas) {
@@ -90,14 +84,14 @@
         }
         return undoSelectionRange;
     };
 
     /**
-    * UndoManager.redo(dontSelect) -> Void
-    * - dontSelect (Boolean): {:dontSelect}
-    *
     * [Perform a redo operation on the document, reimplementing the last change.]{: #UndoManager.redo}
+    * @param {Boolean} dontSelect {:dontSelect}
+    *
+    * 
     **/
     this.redo = function(dontSelect) {
         var deltas = this.$redoStack.pop();
         var redoSelectionRange = null;
         if (deltas) {
@@ -107,31 +101,30 @@
         }
         return redoSelectionRange;
     };
 
     /**
-    * UndoManager.reset() -> Void
-    *
+    * 
     * Destroys the stack of undo and redo redo operations.
     **/
     this.reset = function() {
         this.$undoStack = [];
         this.$redoStack = [];
     };
 
     /**
-    * UndoManager.hasUndo() -> Boolean
-    *
+    * 
     * Returns `true` if there are undo operations left to perform.
+    * @returns {Boolean}
     **/
     this.hasUndo = function() {
         return this.$undoStack.length > 0;
     };
 
     /**
-    * UndoManager.hasRedo() -> Boolean
-    *
+    * 
     * Returns `true` if there are redo operations left to perform.
+    * @returns {Boolean}
     **/
     this.hasRedo = function() {
         return this.$redoStack.length > 0;
     };
 