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

remove doc comments describing events that ace doesn't emit

Browse source
This commit is contained in:
nightwing 2012-08-17 00:04:47 +04:00
commit 330ca76bfe
5 changed files with 58 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

55
lib/ace/edit_session.js
View file

@ -56,10 +56,40 @@ var SearchHighlight = require("./search_highlight").SearchHighlight;
/**
* class EditSession
*
* Stores various states related to a [[Document `Document`]]. A single `EditSession` can be in charge of several `Document`s.
* Stores all the data about [[Editor `Editor`]] state providing easy way to change editors state. `EditSession` can be attached to only one [[Document `Document`]]. Same `Document` can be attached to several `EditSession`s.
*
**/
// events
/**
* EditSession@change(e)
*
* Emitted when the document changes.
**/
/**
* EditSession@tokenizerUpdate(e)
*
* Emitted when a background tokenizer asynchronousely processes new rows.
*
**/
/**
* EditSession@changeFold(e)
*
* Emitted when a code fold added or removed.
*
**/
/**
* EditSession@changeScrollTop()
*
* Emitted when the scroll top changes.
**/
/**
* EditSession@changeScrollLeft()
*
* Emitted when the scroll left changes.
**/
/**
* new EditSession(text, mode)
* - text (Document | String): If `text` is a `Document`, it associates the `EditSession` with it. Otherwise, a new `Document` is created, with the initial text
@ -174,22 +204,11 @@ var EditSession = function(text, mode) {
return low && low -1;
};
/**
* EditSession@onChangeFold(e)
*
* Emitted when a code fold changes its state.
*
**/
this.onChangeFold = function(e) {
var fold = e.data;
this.$resetRowCache(fold.start.row);
};
/**
* EditSession@onChange(e)
*
* Emitted when the document changes.
**/
this.onChange = function(e) {
var delta = e.data;
this.$modified = true;
@ -580,11 +599,11 @@ var EditSession = function(text, mode) {
};
/**
* EditSession.addDynamicMarker(marker) -> {update}
* - marker : object with update method
* - inFront (Boolean): Set to `true` to establish a front marker
*
**/
* EditSession.addDynamicMarker(marker) -> Object
* - marker (Object): object with update method
* - inFront (Boolean): Set to `true` to establish a front marker
*
**/
this.addDynamicMarker = function(marker, inFront) {
if (!marker.update)
return;
@ -804,7 +823,7 @@ var EditSession = function(text, mode) {
};
/**
* EditSession@onReloadTokenizer(e)
* EditSession.onReloadTokenizer(e)
*
* 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.
**/