update doc comments

This commit is contained in:
nightwing 2013-01-27 13:47:49 +04:00
commit 99879fdeef
3 changed files with 168 additions and 221 deletions

View file

@ -456,27 +456,6 @@ var EditSession = function(text, mode) {
}
};
/**
* Pass `true` to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character (`'\t'`).
* @param {Boolean} useSoftTabs Value indicating whether or not to use soft tabs
*
**/
/**
* Returns `true` if soft tabs are being used, `false` otherwise.
* @returns {Boolean}
**/
/**
* Set the number of spaces that define a soft tab; for example, passing in `4` transforms the soft tabs to be equivalent to four spaces. This function also emits the `changeTabSize` event.
* @param {Number} tabSize The new tab size
*
*
**/
/**
* Returns the current tab size.
**/
/**
* Returns `true` if the character at the position is a soft tab.
* @param {Object} position The position to check
@ -844,14 +823,6 @@ var EditSession = function(text, mode) {
return this.doc.getNewLineMode();
};
/**
* Identifies if you want to use a worker for the `EditSession`.
* @param {Boolean} useWorker Set to `true` to use a worker
*
**/
/**
* Returns `true` if workers are being used.
**/
/**
* Reloads all the tokens on the current session. This function calls [[BackgroundTokenizer.start `BackgroundTokenizer.start ()`]] to all the rows; it also emits the `'tokenizerUpdate'` event.
**/
@ -2366,6 +2337,26 @@ var EditSession = function(text, mode) {
require("./edit_session/folding").Folding.call(EditSession.prototype);
require("./edit_session/bracket_match").BracketMatch.call(EditSession.prototype);
/**
* Pass `true` to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character (`'\t'`).
* @param {Boolean} useSoftTabs Value indicating whether or not to use soft tabs
* @method EditSession.setUseSoftTabs
**/
/**
* Set the number of spaces that define a soft tab; for example, passing in `4` transforms the soft tabs to be equivalent to four spaces. This function also emits the `changeTabSize` event.
* @param {Number} tabSize The new tab size
* @method EditSession.setTabSize
**/
/**
* Identifies if you want to use a worker for the `EditSession`.
* @param {Boolean} useWorker Set to `true` to use a worker
* @method EditSession.setUseWorker
**/
/**
* Sets the number displayed in the gutter for the first line of code.
* @param {Number} firstLineNumber The number displayed in the gutter for the first line of code.
* @method EditSession.setFirstLineNumber
*/
config.defineOptions(EditSession.prototype, "session", {
wrap: {
set: function(value) {