Update API docs

This commit is contained in:
Garen Torikian 2012-08-17 12:27:56 -07:00
commit 17fcc42923
27 changed files with 1176 additions and 1186 deletions

View file

@ -207,8 +207,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
/**
* BackgroundTokenizer.getTokens(row) -> [Object]
* - firstRow (Number): The row to start at
* - lastRow (Number): The row to finish at
* - firstRow (Number): The row to get tokens at
*
* Gives list of tokens of the row. (tokens are cached)
*
@ -219,7 +218,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
/**
* BackgroundTokenizer.getState(row) -> String
* - row (Number): The row to start at
* - row (Number): The row to get state at
*
* [Returns the state of tokenization at the end of a row.]{: #BackgroundTokenizer.getState}
**/

View file

@ -599,10 +599,11 @@ var EditSession = function(text, mode) {
};
/**
* EditSession.addDynamicMarker(marker) -> Object
* EditSession.addDynamicMarker(marker, inFront) -> Object
* - marker (Object): object with update method
* - inFront (Boolean): Set to `true` to establish a front marker
*
* Adds a dynamic marker to the session.
**/
this.addDynamicMarker = function(marker, inFront) {
if (!marker.update)

View file

@ -238,7 +238,7 @@ var Editor = function(renderer, session) {
/** related to: Document.setValue
* Editor.setValue(val [,dontSelect]) -> String
* - val (String): The new value to set for the document
* - cursorPos (number): 0: selectAll, -1 document start, 1 end
* - cursorPos (Number): 0: selectAll, -1 document start, 1 end
*
* Sets the current document to `val`.
**/
@ -1046,7 +1046,7 @@ var Editor = function(renderer, session) {
this.$modeBehaviours = true;
/**
* Editor.setBehavioursEnabled()
* Editor.setBehavioursEnabled(enabled)
* - enabled (Boolean): Enables or disables behaviors
*
* Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.]{: #BehaviorsDef}
@ -1623,7 +1623,7 @@ var Editor = function(renderer, session) {
};
/** related to: VirtualRenderer.scrollToLine
* Editor.scrollToLine(line, center)
* Editor.scrollToLine(line, center, animate, callback())
* - line (Number): The line to scroll to
* - center (Boolean): If `true`
* - animate (Boolean): If `true` animates scrolling
@ -1763,7 +1763,7 @@ var Editor = function(renderer, session) {
};
/**
* Editor.gotoLine(lineNumber, column)
* Editor.gotoLine(lineNumber, column, animate)
* - lineNumber (Number): The line number to go to
* - column (Number): A column number to go to
* - animate (Boolean): If `true` animates scolling
@ -2007,7 +2007,7 @@ var Editor = function(renderer, session) {
};
/** related to: Search.find
* Editor.find(needle, options)
* Editor.find(needle, options, animate)
* - needle (String): The text to search for (optional)
* - options (Object): An object defining various search properties
* - animate (Boolean): If `true` animate scrolling
@ -2054,7 +2054,7 @@ var Editor = function(renderer, session) {
};
/** related to: Editor.find
* Editor.findNext(options)
* Editor.findNext(options, animate)
* - options (Object): search options
* - animate (Boolean): If `true` animate scrolling
*
@ -2065,7 +2065,7 @@ var Editor = function(renderer, session) {
};
/** related to: Editor.find
* Editor.findPrevious(options)
* Editor.findPrevious(options, animate)
* - options (Object): search options
* - animate (Boolean): If `true` animate scrolling
*

View file

@ -82,7 +82,7 @@ var ScrollBar = function(parent) {
oop.implement(this, EventEmitter);
/**
* ScrollBar@onScroll
* ScrollBar@onScroll()
*
* Emitted when the scroll bar, well, scrolls.
*