fix jsDoc annotation errors

Author: mkslanc

Diff for: src/autocomplete/popup.js

@@ -25,17 +25,17 @@ var $singleLineEditor = function(el) {
     return editor;
 };
 
-    /**
-     * This object is used in some places where needed to show popups - like prompt; autocomplete etc.
-     * @class
-     */
-
-    /**
-     * Creates and renders single line editor in popup window. If `parentNode` param is isset, then attaching it to this element.
-     * @param {Element} parentNode
-     * @constructor
-     */
-    var AcePopup = function(parentNode) {
+/**
+ * This object is used in some places where needed to show popups - like prompt; autocomplete etc.
+ * @class
+ */
+
+/**
+ * Creates and renders single line editor in popup window. If `parentNode` param is isset, then attaching it to this element.
+ * @param {Element} parentNode
+ * @constructor
+ */
+var AcePopup = function(parentNode) {
     var el = dom.createElement("div");
     var popup = new $singleLineEditor(el);
 

Diff for: src/bidihandler.js

@@ -226,9 +226,9 @@ var BidiHandler = function(session) {
 
     /**
      * Returns offset of character at position defined by column.
-     * @param {Number} the screen column position
+     * @param {Number} col the screen column position
      *
-     * @return {int} horizontal pixel offset of given screen column
+     * @return {Number} horizontal pixel offset of given screen column
      **/
     this.getPosLeft = function(col) {
         col -= this.wrapIndent;
@@ -258,10 +258,10 @@ var BidiHandler = function(session) {
 
     /**
      * Returns 'selections' - array of objects defining set of selection rectangles
-     * @param {Number} the start column position
-     * @param {Number} the end column position
+     * @param {Number} startCol the start column position
+     * @param {Number} endCol the end column position
      *
-     * @return {Array of Objects} Each object contains 'left' and 'width' values defining selection rectangle.
+     * @return {Object[]} Each object contains 'left' and 'width' values defining selection rectangle.
     **/
     this.getSelections = function(startCol, endCol) {
         var map = this.bidiMap, levels = map.bidiLevels, level, selections = [], offset = 0,
@@ -298,7 +298,7 @@ var BidiHandler = function(session) {
 
     /**
      * Converts character coordinates on the screen to respective document column number
-     * @param {int} character horizontal offset
+     * @param {Number} posX character horizontal offset
      *
      * @return {Number} screen column number corresponding to given pixel offset
     **/

Diff for: src/document.js

@@ -16,7 +16,7 @@ var Anchor = require("./anchor").Anchor;
 /**
  *
  * Creates a new `Document`. If `text` is included, the `Document` contains those strings; otherwise, it's empty.
- * @param {String | Array} text The starting text
+ * @param {String | String[]} textOrLines text The starting text
  * @constructor
  **/
 
@@ -190,7 +190,7 @@ var Document = function(textOrLines) {
      * Returns all the text within `range` as an array of lines.
      * @param {Range} range The range to work with.
      * 
-     * @returns {Array}
+     * @returns {string[]}
      **/
     this.getLinesForRange = function(range) {
         var lines;
@@ -322,7 +322,7 @@ var Document = function(textOrLines) {
     /**
      * Inserts the elements in `lines` into the document as full lines (does not merge with existing line), starting at the row index given by `row`. This method also triggers the `"change"` event.
      * @param {Number} row The index of the row to insert at
-     * @param {Array} lines An array of strings
+     * @param {string[]} lines An array of strings
      * @returns {Object} Contains the final row and column, like this:  
      *   ```
      *   {row: endRow, column: 0}
@@ -358,7 +358,7 @@ var Document = function(textOrLines) {
     /**
      * Inserts the elements in `lines` into the document, starting at the position index given by `row`. This method also triggers the `"change"` event.
      * @param {Number} row The index of the row to insert at
-     * @param {Array} lines An array of strings
+     * @param {string[]} lines An array of strings
      * @returns {Object} Contains the final row and column, like this:  
      *   ```
      *   {row: endRow, column: 0}
@@ -514,7 +514,7 @@ var Document = function(textOrLines) {
 
     /**
      * Applies all changes in `deltas` to the document.
-     * @param {Array} deltas An array of delta objects (can include "insert" and "remove" actions)
+     * @param {Delta[]} deltas An array of delta objects (can include "insert" and "remove" actions)
      **/
     this.applyDeltas = function(deltas) {
         for (var i=0; i<deltas.length; i++) {
@@ -524,7 +524,7 @@ var Document = function(textOrLines) {
 
     /**
      * Reverts all changes in `deltas` from the document.
-     * @param {Array} deltas An array of delta objects (can include "insert" and "remove" actions)
+     * @param {Delta[]} deltas An array of delta objects (can include "insert" and "remove" actions)
      **/
     this.revertDeltas = function(deltas) {
         for (var i=deltas.length-1; i>=0; i--) {

Diff for: src/edit_session.js

@@ -102,9 +102,9 @@ var SearchHighlight = require("./search_highlight").SearchHighlight;
 //}
 
 /**
- * Sets up a new `EditSession` and associates it with the given `Document` and `TextMode`.
+ * Sets up a new `EditSession` and associates it with the given `Document` and `Mode`.
  * @param {Document | String} text [If `text` is a `Document`, it associates the `EditSession` with it. Otherwise, a new `Document` is created, with the initial text]{: #textParam}
- * @param {TextMode} mode [The initial language mode to use for the document]{: #modeParam}
+ * @param {Mode} mode [The initial language mode to use for the document]{: #modeParam}
  *
  * @constructor
  **/
@@ -683,7 +683,7 @@ EditSession.$uid = 0;
      */
     /**
      * Sets annotations for the `EditSession`. This functions emits the `'changeAnnotation'` event.
-     * @param {Array} annotations A list of annotations
+     * @param {Annotation[]} annotations A list of annotations
      *
      **/
     this.setAnnotations = function(annotations) {
@@ -693,7 +693,7 @@ EditSession.$uid = 0;
 
     /**
      * Returns the annotations for the `EditSession`.
-     * @returns {Array}
+     * @returns {Annotation[]}
      **/
     this.getAnnotations = function() {
         return this.$annotations || [];
@@ -1113,7 +1113,7 @@ EditSession.$uid = 0;
 
     /**
      * Reverts previous changes to your document.
-     * @param {Array} deltas An array of previous changes
+     * @param {Delta[]} deltas An array of previous changes
      * @param {Boolean} dontSelect [If `true`, doesn't select the range of where the change occured]{: #dontSelect}
      *
      * @returns {Range}
@@ -1142,7 +1142,7 @@ EditSession.$uid = 0;
 
     /**
      * Re-implements a previously undone change to your document.
-     * @param {Array} deltas An array of previous changes
+     * @param {Delta[]} deltas An array of previous changes
      * @param {Boolean} dontSelect {:dontSelect}
      *
      * @returns {Range}
@@ -2077,7 +2077,7 @@ EditSession.$uid = 0;
      * Converts characters coordinates on the screen to characters coordinates within the document. [This takes into account code folding, word wrap, tab size, and any other visual modifications.]{: #conversionConsiderations}
      * @param {Number} screenRow The screen row to check
      * @param {Number} screenColumn The screen column to check
-     * @param {int} screen character x-offset [optional]
+     * @param {Number} offsetX screen character x-offset [optional]
      *
      * @returns {Object} The object returned has two properties: `row` and `column`.
      *

Diff for: src/keyboard/vim.js

@@ -4503,7 +4503,7 @@ dom.importCssString(".normal-mode .ace_cursor{\
     /**
      * @param {CodeMirror} cm CodeMirror object.
      * @param {Pos} cur The position to start from.
-     * @param {int} repeat Number of words to move past.
+     * @param {Number} repeat Number of words to move past.
      * @param {boolean} forward True to search forward. False to search
      *     backward.
      * @param {boolean} wordEnd True to move to end of word. False to move to

Diff for: src/lib/bidiutil.js

@@ -364,10 +364,10 @@ exports.hasBidiCharacters = function(text, textCharTypes){
 /**
  * Returns visual index corresponding to logical index basing on logicalFromvisual 
  * map provided by Unicode Bidi algorithm.
- * @param {int} logical index of character in text buffer
- * @param {Object} object containing logicalFromVisual map
+ * @param {Number} logIdx logical index of character in text buffer
+ * @param {Object} rowMap object containing logicalFromVisual map
  *
- * @return {int} visual index (on display) corresponding to logical index
+ * @return {Number} visual index (on display) corresponding to logical index
  **/	
 exports.getVisualFromLogicalIdx = function(logIdx, rowMap) {
 	for (var i = 0; i < rowMap.logicalFromVisual.length; i++) {

Diff for: src/mode/folding/sqlserver.js

@@ -47,7 +47,7 @@ oop.inherits(FoldMode, BaseFoldMode);
     };
 
     /**
-     * @returns {range} folding block for sequence that starts with 'CASE' or 'BEGIN' and ends with 'END'
+     * @returns {Range} folding block for sequence that starts with 'CASE' or 'BEGIN' and ends with 'END'
      * @param {string} matchSequence - the sequence of charaters that started the fold widget, which should remain visible when the fold widget is folded
      */
     this.getBeginEndBlock = function(session, row, column, matchSequence) {

Diff for: src/multi_select.js

@@ -157,7 +157,7 @@ var EditSession = require("./edit_session").EditSession;
 
     /**
      * Returns a concatenation of all the ranges.
-     * @returns {Array}
+     * @returns {Range[]}
      * @method Selection.getAllRanges
      **/
     this.getAllRanges = function() {

Diff for: src/scrollbar.js

@@ -16,7 +16,7 @@ var MAX_SCROLL_H = 0x8000;
 
 /**
  * Creates a new `ScrollBar`. `parent` is the owner of the scroll bar.
- * @param {DOMElement} parent A DOM element 
+ * @param {Element} parent A DOM element
  *
  * @constructor
  **/
@@ -56,7 +56,7 @@ var ScrollBar = function(parent) {
 
 /**
  * Creates a new `VScrollBar`. `parent` is the owner of the scroll bar.
- * @param {DOMElement} parent A DOM element
+ * @param {Element} parent A DOM element
  * @param {Object} renderer An editor renderer
  *
  * @constructor
@@ -161,7 +161,7 @@ oop.inherits(VScrollBar, ScrollBar);
 
 /**
  * Creates a new `HScrollBar`. `parent` is the owner of the scroll bar.
- * @param {DOMElement} parent A DOM element
+ * @param {Element} parent A DOM element
  * @param {Object} renderer An editor renderer
  *
  * @constructor

Diff for: src/virtual_renderer.js

@@ -27,7 +27,7 @@ dom.importCssString(editorCss, "ace_editor.css", false);
 
 /**
  * Constructs a new `VirtualRenderer` within the `container` specified, applying the given `theme`.
- * @param {DOMElement} container The root element of the editor
+ * @param {Element} container The root element of the editor
  * @param {String} theme The starting theme
  *
  * @constructor
@@ -1146,7 +1146,7 @@ var VirtualRenderer = function(container, theme) {
 
     /**
      * Sets annotations for the gutter.
-     * @param {Array} annotations An array containing annotations
+     * @param {Annotation[]} annotations An array containing annotations
      *
      **/
     this.setAnnotations = function(annotations) {