jyapayne/ace
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix documentation for position

Browse source
This commit is contained in:
nightwing 2012-11-25 23:55:53 +04:00
commit b9417a10be
2 changed files with 31 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

34
lib/ace/edit_session.js
View file

@ -104,19 +104,19 @@ var SearchHighlight = require("./search_highlight").SearchHighlight;
**/
/**
* Emitted when the current mode changes.
*
*
* @event changeMode
*
**/
/**
* Emitted when the wrap mode changes.
*
*
* @event changeWrapMode
*
**/
/**
* Emitted when the wrapping limit changes.
*
*
* @event changeWrapLimit
*
**/
@ -138,8 +138,8 @@ var SearchHighlight = require("./search_highlight").SearchHighlight;
*
* @param {Number} scrollLeft The new scroll left value
**/
/**
*
* Sets up a new `EditSession` and associates it with the given `Document` and `TextMode`.
@ -172,7 +172,7 @@ var EditSession = function(text, mode) {
if (typeof text != "object" || !text.getLine)
text = new Document(text);
this.setDocument(text);
this.setDocument(text);
this.selection = new Selection(this);
this.setMode(mode);
@ -1158,18 +1158,18 @@ var EditSession = function(text, mode) {
* Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`.
* @param {Number} firstRow The first row index to retrieve
* @param {Number} lastRow The final row index to retrieve
*
*
* @returns [String]
*
**/
*
**/
this.getLines = function(firstRow, lastRow) {
return this.doc.getLines(firstRow, lastRow);
};
/**
* Returns the number of rows in the document.
* Returns the number of rows in the document.
* @returns {Number}
**/
**/
this.getLength = function() {
return this.doc.getLength();
};
@ -1177,18 +1177,18 @@ var EditSession = function(text, mode) {
/**
* {:Document.getTextRange.desc}
* @param {Range} range The range to work with
*
*
* @returns {Range}
**/
**/
this.getTextRange = function(range) {
return this.doc.getTextRange(range || this.selection.getRange());
};
/**
* Inserts a block of `text` and the indicated `position`.
* @param {Number} position The position to start inserting at
* @param {Object} position The position {row, column} to start inserting at
* @param {String} text A chunk of text to insert
* @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
* @returns {Object} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
*
*
**/
@ -2027,7 +2027,7 @@ var EditSession = function(text, mode) {
* The first position indicates the number of columns for `str` on screen.<br/>
* The second value contains the position of the document column that this function read until.
*
*
*
*
*
**/
@ -2076,7 +2076,7 @@ var EditSession = function(text, mode) {
/**
* Returns the position (on screen) for the last character in the provided screen row.
* @param {Number} screenRow The screen row to check
*
*
*
* @related EditSession.documentToScreenColumn
**/