diff --git a/lib/ace/background_tokenizer.js b/lib/ace/background_tokenizer.js index 8dfa11c9..804fe9a5 100644 --- a/lib/ace/background_tokenizer.js +++ b/lib/ace/background_tokenizer.js @@ -42,7 +42,7 @@ var oop = require("./lib/oop"); var EventEmitter = require("./lib/event_emitter").EventEmitter; /** - * class Background_Tokenizer + * class BackgroundTokenizer * * Tokenizes items..in the background? TODO * @@ -50,7 +50,7 @@ var EventEmitter = require("./lib/event_emitter").EventEmitter; **/ /** - * new Background_Tokenizer(tokenizer, editor) + * new BackgroundTokenizer(tokenizer, editor) * - tokenizer (Tokenizer): The tokenizer to use * - editor (Editor): The editor to associate with * @@ -101,7 +101,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { oop.implement(this, EventEmitter); /** - * Background_Tokenizer.setTokenizer(tokenizer) -> Void + * BackgroundTokenizer.setTokenizer(tokenizer) -> Void * - tokenizer (Tokenizier): The new tokenizer to use * * Sets a new tokenizer for this object. @@ -116,7 +116,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** - * Background_Tokenizer.setDocument(doc) -> Void + * BackgroundTokenizer.setDocument(doc) -> Void * - doc (Document): The new document to associate with * * Sets a new document to associate with this object. @@ -131,7 +131,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** - * Background_Tokenizer.fireUpdateEvent(firstRow, lastRow) -> Void + * BackgroundTokenizer.fireUpdateEvent(firstRow, lastRow) -> Void * - firstRow (Number): The starting row region * - lastRow (Number): The final row region * @@ -148,7 +148,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** - * Background_Tokenizer.start(startRow, lastRow) -> Void + * BackgroundTokenizer.start(startRow, lastRow) -> Void * - startRow (Number): The row to start at * - lastRow (Number): The row to finish at * @@ -169,7 +169,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** - * Background_Tokenizer.stop() -> Void + * BackgroundTokenizer.stop() -> Void * * Stops tokenizing. * @@ -182,7 +182,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** related to: BackgroundTokenizer.$tokenizeRows - * Background_Tokenizer.getTokens(firstRow, lastRow) -> Array + * BackgroundTokenizer.getTokens(firstRow, lastRow) -> Array * - firstRow (Number): The row to start at * - lastRow (Number): The row to finish at * @@ -195,7 +195,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** related to: BackgroundTokenizer.$tokenizeRows - * Background_Tokenizer.getState(row) -> Array + * BackgroundTokenizer.getState(row) -> Array * - row (Number): The row to start at * * Retrieves the state of tokenization for a row. Returns the tokenized row. @@ -207,7 +207,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { }; /** - * Background_Tokenizer.$tokenizeRows(firstRow, lastRow) -> Array + * BackgroundTokenizer.$tokenizeRows(firstRow, lastRow) -> Array * - startRow (Number): The row to start at * - lastRow (Number): The row to finish at * diff --git a/lib/ace/commands/command_manager.js b/lib/ace/commands/command_manager.js index 7b24fb45..10c94cd8 100644 --- a/lib/ace/commands/command_manager.js +++ b/lib/ace/commands/command_manager.js @@ -3,6 +3,24 @@ define(function(require, exports, module) { var keyUtil = require("../lib/keys"); +/** + * class CommandManager + * + * + * + * + **/ + +/** + * new CommandManager(platform, commands) + * - platform (String): Identifier for the platform; must be either `'mac'` or `'win'` + * - commands (Array): A list of commands + * + * TODO + * + * + **/ + var CommandManager = function(platform, commands) { if (typeof platform !== "string") throw new TypeError("'platform' argument must be either 'mac' or 'win'"); diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js index feb82194..db2da306 100644 --- a/lib/ace/edit_session.js +++ b/lib/ace/edit_session.js @@ -51,14 +51,14 @@ var Document = require("./document").Document; var BackgroundTokenizer = require("./background_tokenizer").BackgroundTokenizer; /** - * class Edit_Session + * class EditSession * * Some sessions stuff. * **/ /** - * new Edit_Session(text, mode) + * new EditSession(text, mode) * - text (String): Some text * - mode (Boolean): A boolean * @@ -103,7 +103,7 @@ var EditSession = function(text, mode) { oop.implement(this, EventEmitter); /** - * Edit_Session.setDocument(doc) -> Void + * EditSession.setDocument(doc) -> Void * - doc (Document): Some text * * TODO Does some stuff. @@ -124,7 +124,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getDocument() -> Document + * EditSession.getDocument() -> Document * * Returns the `Document` associated with this session. * @@ -134,7 +134,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.$resetRowCache(row) -> Void + * EditSession.$resetRowCache(row) -> Void * - row (Number): The row to work with * * TODO Does some stuff. @@ -155,7 +155,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session@onChangeFold(e) + * EditSession@onChangeFold(e) * * * This event triggers when code folds change their state. TODO @@ -167,7 +167,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session@onChange(e) + * EditSession@onChange(e) * * This changes TODO **/ @@ -195,7 +195,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setValue(text) -> Void + * EditSession.setValue(text) -> Void * - text (String): The new text to place * * Sets the session text. @@ -215,7 +215,7 @@ var EditSession = function(text, mode) { this.getValue = /** - * Edit_Session.toString() -> String + * EditSession.toString() -> String * * Returns the current [[Document `Document`]] as a string. * @@ -225,7 +225,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getSelection() -> String + * EditSession.getSelection() -> String * * Returns the string of the current selection. **/ @@ -234,7 +234,7 @@ var EditSession = function(text, mode) { }; /** related to: BackgroundTokenizer.getState - * Edit_Session.getState(row) -> Array + * EditSession.getState(row) -> Array * - row (Number): The row to start at * * Retrieves the state of tokenization for a row. Returns the tokenized row. TODO @@ -245,7 +245,7 @@ var EditSession = function(text, mode) { }; /** related to: BackgroundTokenizer.getTokens - * Edit_Session.getTokens(firstRow, lastRow) -> Array + * EditSession.getTokens(firstRow, lastRow) -> Array * - firstRow (Number): The row to start at * - lastRow (Number): The row to finish at * @@ -257,7 +257,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getTokenAt(row, column) -> Array + * EditSession.getTokenAt(row, column) -> Array * - row (Number): The row number to retrieve from * - column (Number): The column number to retrieve from * @@ -285,7 +285,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setUndoManager(undoManager) -> Void + * EditSession.setUndoManager(undoManager) -> Void * - undoManager (UndoManager): The new undo manager * * Sets the undo manager. @@ -303,7 +303,7 @@ var EditSession = function(text, mode) { if (undoManager) { var self = this; /** - * Edit_Session.$syncInformUndoManager() -> Void + * EditSession.$syncInformUndoManager() -> Void * * TODO **/ @@ -347,7 +347,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getUndoManager() -> UndoManager + * EditSession.getUndoManager() -> UndoManager * * Returns the current undo manager. **/ @@ -356,7 +356,7 @@ var EditSession = function(text, mode) { }, /** - * Edit_Session.getTabString() -> String + * EditSession.getTabString() -> String * * Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by [[getTabSize `getTabSize()`]]); otherwise it's simply `'\t'`. **/ @@ -370,7 +370,7 @@ var EditSession = function(text, mode) { this.$useSoftTabs = true; /** - * Edit_Session.setUseSoftTabs(useSoftTabs) -> Void + * EditSession.setUseSoftTabs(useSoftTabs) -> Void * - useSoftTabs (Boolean): Value indicating whether or not to use soft tabs * * Pass `true` to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character (`'\t'`). @@ -383,7 +383,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getUseSoftTabs() -> Boolean + * EditSession.getUseSoftTabs() -> Boolean * * Returns `true` if soft tabs are being used, `false` otherwise. * @@ -394,7 +394,7 @@ var EditSession = function(text, mode) { this.$tabSize = 4; /** - * Edit_Session.setTabSize(tabSize) -> Void + * EditSession.setTabSize(tabSize) -> Void * - tabSize (Number): The new tab size * * 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. @@ -408,7 +408,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getTabSize() -> Number + * EditSession.getTabSize() -> Number * * Returns the current tab size. **/ @@ -417,7 +417,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.isTabStop(position) -> Boolean + * EditSession.isTabStop(position) -> Boolean * - position (Number): The position to check * * Returns `true` if the character at the position is a soft tab. TODO @@ -428,7 +428,7 @@ var EditSession = function(text, mode) { this.$overwrite = false; /** - * Edit_Session.setOverwrite(overwrite) -> Void + * EditSession.setOverwrite(overwrite) -> Void * - overwrite (Boolean): Defines wheter or not to set overwrites * * Pass in `true` to enable overwrites in your session, or `false` to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of `overwrite` changes, this function also emites the `changeOverwrite` event. @@ -442,7 +442,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getOverwrite() -> Boolean + * EditSession.getOverwrite() -> Boolean * * Returns `true` if overwrites are enabled; `false` otherwise. **/ @@ -451,7 +451,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.toggleOverwrite() -> Void + * EditSession.toggleOverwrite() -> Void * * Sets the value of overwrite to the opposite of whatever it currently is. **/ @@ -460,7 +460,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getBreakpoints() -> Array + * EditSession.getBreakpoints() -> Array * * Returns an array of numbers, indicating which rows have breakpoints. **/ @@ -469,7 +469,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setBreakpoints(rows) -> Void + * EditSession.setBreakpoints(rows) -> Void * - rows (Array): An array of row indicies * * Sets a breakpoint on every row number given by `rows`. This function also emites the `'changeBreakpoint'` event. @@ -484,7 +484,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.clearBreakpoints() -> Void + * EditSession.clearBreakpoints() -> Void * * Removes all breakpoints on the rows. This function also emites the `'changeBreakpoint'` event. **/ @@ -494,7 +494,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setBreakpoint(row) -> Void + * EditSession.setBreakpoint(row) -> Void * - row (Number): A row index * * Sets a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event. @@ -505,7 +505,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.clearBreakpoint(row) -> Void + * EditSession.clearBreakpoint(row) -> Void * - row (Number): A row index * * Removes a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event. @@ -516,7 +516,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.addMarker(range, clazz, type, inFront) -> Number + * EditSession.addMarker(range, clazz, type, inFront) -> Number * - range (Range): * - clazz (String): * - type (String): @@ -547,7 +547,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.removeMarker(markerId) -> Void + * EditSession.removeMarker(markerId) -> Void * - markerId (Number): A number representing a marker * * Removes the marker with the specified ID. If this marker was in front, the `'changeFrontMarker'` event is emitted. If the marker was in the back, the `'changeBackMarker'` event is emitted. @@ -566,7 +566,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getMarkers(inFront) -> Array + * EditSession.getMarkers(inFront) -> Array * - inFront (Boolean): If `true`, indicates you only want front markers; `false` indicates only back markers * * Returns an array containing the IDs of all the markers, either front or back. @@ -586,7 +586,7 @@ var EditSession = function(text, mode) { * } */ /** - * Edit_Session.setAnnotations(annotations) -> Void + * EditSession.setAnnotations(annotations) -> Void * - annotations (Array): * * This functions emits the `'changeAnnotation'` event. TODO @@ -605,7 +605,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getAnnotations() -> Array + * EditSession.getAnnotations() -> Array * * TODO **/ @@ -614,7 +614,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.clearAnnotations() -> Void + * EditSession.clearAnnotations() -> Void * * Clears all the annotations for this session. This function also triggers the `'changeAnnotation'` event. **/ @@ -624,7 +624,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.$detectNewLine(text) -> Void + * EditSession.$detectNewLine(text) -> Void * - text (String): A block of text * * If `text` contains either the newline (`\n`) or carriage-return ('\r') characters, [[autoNewLine `autoNewLine`]] stores that value. TODO @@ -640,7 +640,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getWordRange(row, column) -> Range + * EditSession.getWordRange(row, column) -> Range * - row (Number): The row to check * - column (Number): The column to check * @@ -678,7 +678,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getAWordRange(row, column) -> Range + * EditSession.getAWordRange(row, column) -> Range * - row (Number): The row number to start from * - column (Number): The column number to start from * @@ -695,7 +695,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setNewLineMode(newLineMode) -> Void + * EditSession.setNewLineMode(newLineMode) -> Void * - newLineMode (String): * * TODO @@ -705,7 +705,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getNewLineMode() -> String + * EditSession.getNewLineMode() -> String * * TODO Returns the current new line mode. **/ @@ -715,7 +715,7 @@ var EditSession = function(text, mode) { this.$useWorker = true; /** - * Edit_Session.setUseWorker(useWorker) -> Void + * EditSession.setUseWorker(useWorker) -> Void * * TODO **/ @@ -731,7 +731,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getUseWorker() -> Boolean + * EditSession.getUseWorker() -> Boolean * * TODO **/ @@ -740,7 +740,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session@onReloadTokenizer(e) -> Void + * EditSession@onReloadTokenizer(e) -> Void * * 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. **/ @@ -752,7 +752,7 @@ var EditSession = function(text, mode) { this.$mode = null; /** - * Edit_Session.setMode(mode) -> Void + * EditSession.setMode(mode) -> Void * * TODO **/ @@ -815,7 +815,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getMode() -> String + * EditSession.getMode() -> String * * TODO Returns the current mode. **/ @@ -825,7 +825,7 @@ var EditSession = function(text, mode) { this.$scrollTop = 0; /** - * Edit_Session.setScrollTop(scrollTop) -> Void + * EditSession.setScrollTop(scrollTop) -> Void * * This function also emits the `'changeScrollTop'` event. TODO **/ @@ -839,7 +839,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getScrollTop() -> Number + * EditSession.getScrollTop() -> Number * * [Returns the value of the distance between the top of the editor and the topmost part of the visible content.](~EditSession.getScrollTop) **/ @@ -849,7 +849,7 @@ var EditSession = function(text, mode) { this.$scrollLeft = 0; /** - * Edit_Session.setScrollLeft(scrollLeft) -> Void + * EditSession.setScrollLeft(scrollLeft) -> Void * * [Sets the value of the distance between the left of the editor and the leftmost part of the visible content.](~EditSession.setScrollLeft) **/ @@ -863,7 +863,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getScrollLeft() -> Number + * EditSession.getScrollLeft() -> Number * * [Returns the value of the distance between the left of the editor and the leftmost part of the visible content.](~EditSession.getScrollLeft) **/ @@ -872,7 +872,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getWidth() -> Number + * EditSession.getWidth() -> Number * * Returns the width of the document. **/ @@ -882,7 +882,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getScreenWidth() -> Number + * EditSession.getScreenWidth() -> Number * * Returns the width of the screen. **/ @@ -931,7 +931,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.getLine - * Edit_Session.getLine(row) -> String + * EditSession.getLine(row) -> String * - row (Number): The row to retrieve from * * Returns a verbatim copy of the given line as it is in the document @@ -942,7 +942,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.getLines - * Edit_Session.getLines(firstRow, lastRow) -> Array + * EditSession.getLines(firstRow, lastRow) -> Array * - firstRow (Number): The first row index to retrieve * - lastRow (Number): The final row index to retrieve * @@ -954,7 +954,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.getLength - * Edit_Session.getLength()-> Number + * EditSession.getLength()-> Number * * Returns the number of rows in the document. **/ @@ -963,7 +963,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.getTextRange - * Edit_Session.getTextRange(range) -> Array + * EditSession.getTextRange(range) -> Array * - range (String): blah * * TODO @@ -973,7 +973,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.insert - * Edit_Session.insert(position, text) -> Number + * EditSession.insert(position, text) -> Number * - position (Number): The position to start inserting at * - text (String): A chunk of text to insert * @@ -989,7 +989,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.remove - * Edit_Session.remove(range) -> Object + * EditSession.remove(range) -> Object * - range (Range): A specified Range to remove * * Removes the `range` from the document. @@ -1003,7 +1003,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.undoChanges(deltas, dontSelect) -> Range + * EditSession.undoChanges(deltas, dontSelect) -> Range * - deltas (Array): * - dontSelect (Boolean): * @@ -1036,7 +1036,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.redoChanges(deltas, dontSelect) -> Range + * EditSession.redoChanges(deltas, dontSelect) -> Range * - deltas (Array): * - dontSelect (Boolean): * @@ -1065,7 +1065,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setUndoSelect(enable) -> Void + * EditSession.setUndoSelect(enable) -> Void * - enable (Boolean): * * TODO @@ -1075,7 +1075,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.$getUndoSelection(deltas, isUndo, lastUndoRange) -> Range + * EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange) -> Range * * TODO **/ @@ -1134,7 +1134,7 @@ var EditSession = function(text, mode) { }, /** related to: Document.replace - * Edit_Session.replace(range, text) -> Object + * EditSession.replace(range, text) -> Object * - range (Range): A specified Range to replace * - text (String): The new text to use as a replacement * @@ -1156,7 +1156,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.moveText(fromRange, toPosition) -> Range + * EditSession.moveText(fromRange, toPosition) -> Range * - fromRange (Range): The range of text you want moved within the document * - toPosition (Object): The location (row and column) where you want to move the text to * @@ -1201,7 +1201,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.indentRows(startRow, endRow, indentString) -> Void + * EditSession.indentRows(startRow, endRow, indentString) -> Void * - startRow (Number): Starting row * - endRow (Number): Ending row * - indentString (String): The indent token @@ -1218,7 +1218,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.outdentRows(range) -> Void + * EditSession.outdentRows(range) -> Void * - range (Range): A range of rows * * Outdents all the rows defined by the `start` and `end` properties of `range`. @@ -1249,7 +1249,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.insertLines - * Edit_Session.moveLinesUp(firstRow, lastRow) -> Number + * EditSession.moveLinesUp(firstRow, lastRow) -> Number * - firstRow (Number): The starting row to move up * - lastRow (Number): The final row to move up * @@ -1269,7 +1269,7 @@ var EditSession = function(text, mode) { }; /** related to: Document.insertLines - * Edit_Session.moveLinesDown(firstRow, lastRow) -> Number + * EditSession.moveLinesDown(firstRow, lastRow) -> Number * - firstRow (Number): The starting row to move down * - lastRow (Number): The final row to move down * @@ -1289,7 +1289,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.duplicateLines(firstRow, lastRow) -> Number + * EditSession.duplicateLines(firstRow, lastRow) -> Number * - firstRow (Number): The starting row to duplicate * - lastRow (Number): The final row to duplicate * @@ -1378,7 +1378,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.setUseWrapMode(useWrapMode) -> Void + * EditSession.setUseWrapMode(useWrapMode) -> Void * * TODO line wrapping ? **/ @@ -1403,7 +1403,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getUseWrapMode() -> Boolean + * EditSession.getUseWrapMode() -> Boolean * * Returns `true` if wrap mode is being used; `false` otherwise. **/ @@ -1416,7 +1416,7 @@ var EditSession = function(text, mode) { // in that direction. Or set both parameters to the same number to pin // the limit to that value. /** - * Edit_Session.setWrapLimitRange(min, max) -> Void + * EditSession.setWrapLimitRange(min, max) -> Void * * TODO At what point to wrap ? **/ @@ -1433,7 +1433,7 @@ var EditSession = function(text, mode) { // This should generally only be called by the renderer when a resize // is detected. /** - * Edit_Session.adjustWrapLimit(desiredLimit) -> Boolean + * EditSession.adjustWrapLimit(desiredLimit) -> Boolean * - desiredLimit (Number): New limit * * TODO @@ -1467,7 +1467,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getWrapLimit() -> Number + * EditSession.getWrapLimit() -> Number * * Returns the value of wrap limit. **/ @@ -1476,7 +1476,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getWrapLimitRange() -> Object + * EditSession.getWrapLimitRange() -> Object * * Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this: * @@ -1813,7 +1813,7 @@ var EditSession = function(text, mode) { } /** - * Edit_Session.$getStringScreenWidth(str, maxScreenColumn, screenColumn) -> Array + * EditSession.$getStringScreenWidth(str, maxScreenColumn, screenColumn) -> Array * - str (String): The string to calculate the screen width of * - maxScreenColumn (Integer): TODO * - screenColumn (Integer): TODO @@ -1857,7 +1857,7 @@ var EditSession = function(text, mode) { } /** - * Edit_Session.getRowLength(row) -> Number + * EditSession.getRowLength(row) -> Number * - row (Number): The row number to check * * @@ -1872,7 +1872,7 @@ var EditSession = function(text, mode) { } /** - * Edit_Session.getRowHeight(config, row) -> Number + * EditSession.getRowHeight(config, row) -> Number * - config (String): TODO * - row (Number): The row number to check * @@ -1884,7 +1884,7 @@ var EditSession = function(text, mode) { } /** - * Edit_Session.getScreenLastRowColumn(screenRow) -> Number + * EditSession.getScreenLastRowColumn(screenRow) -> Number * * TODO **/ @@ -1894,7 +1894,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getDocumentLastRowColumn(docRow, docColumn) -> Number + * EditSession.getDocumentLastRowColumn(docRow, docColumn) -> Number * * TODO **/ @@ -1904,7 +1904,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getDocumentLastRowColumnPosition(docRow, docColumn) -> Number + * EditSession.getDocumentLastRowColumnPosition(docRow, docColumn) -> Number * * TODO **/ @@ -1914,7 +1914,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getRowSplitData(row) -> undefined | String + * EditSession.getRowSplitData(row) -> undefined | String * * TODO **/ @@ -1927,7 +1927,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getScreenTabSize(screenColumn) -> Number + * EditSession.getScreenTabSize(screenColumn) -> Number * - screenColumn (Number): The screen column to check * * TODO Returns the width of a tab character at `screenColumn`. @@ -1937,7 +1937,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.screenToDocumentRow(screenRow, screenColumn) -> Number + * EditSession.screenToDocumentRow(screenRow, screenColumn) -> Number * * TODO **/ @@ -1946,7 +1946,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.screenToDocumentColumn(screenRow, screenColumn) -> Number + * EditSession.screenToDocumentColumn(screenRow, screenColumn) -> Number * * TODO **/ @@ -1955,7 +1955,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.screenToDocumentPosition(screenRow, screenColumn) -> Number + * EditSession.screenToDocumentPosition(screenRow, screenColumn) -> Number * * TODO **/ @@ -2061,7 +2061,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.documentToScreenPosition(docRow, docColumn) -> Number + * EditSession.documentToScreenPosition(docRow, docColumn) -> Number * * TODO **/ @@ -2169,7 +2169,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.documentToScreenColumn(row, docColumn) -> Number + * EditSession.documentToScreenColumn(row, docColumn) -> Number * * TODO **/ @@ -2178,7 +2178,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.documentToScreenRow(docRow, docColumn) -> Number + * EditSession.documentToScreenRow(docRow, docColumn) -> Number * * TODO **/ @@ -2187,7 +2187,7 @@ var EditSession = function(text, mode) { }; /** - * Edit_Session.getScreenLength() -> Number + * EditSession.getScreenLength() -> Number * * Returns the length of the screen. **/ diff --git a/lib/ace/edit_session/bracket_match.js b/lib/ace/edit_session/bracket_match.js index 89e6506c..01eb0162 100644 --- a/lib/ace/edit_session/bracket_match.js +++ b/lib/ace/edit_session/bracket_match.js @@ -41,6 +41,23 @@ define(function(require, exports, module) { var TokenIterator = require("../token_iterator").TokenIterator; +/** + * class BracketMatch + * + * + * + * + **/ + +/** + * new BracketMatch(position) + * - platform (String): Identifier for the platform; must be either `'mac'` or `'win'` + * - commands (Array): A list of commands + * + * TODO + * + * + **/ function BracketMatch() { this.findMatchingBracket = function(position) { diff --git a/lib/ace/token_iterator.js b/lib/ace/token_iterator.js index 8a6aee3c..027d8c5c 100644 --- a/lib/ace/token_iterator.js +++ b/lib/ace/token_iterator.js @@ -40,14 +40,14 @@ define(function(require, exports, module) { "use strict"; /** - * class Token_Iterator + * class TokenIterator * * This class handles all sorts of token iterizing. Is that even a word? TODO * **/ /** - * new Token_Iterator(session, initialRow, initialColumn) + * new TokenIterator(session, initialRow, initialColumn) * - session (EditSession): The session to associate with * - initialRow (Number): The row to start the tokenizing at * - initialColumn (Number): The column to start the tokenizing at @@ -67,7 +67,7 @@ var TokenIterator = function(session, initialRow, initialColumn) { (function() { /** - * Token_Iterator.stepBackward() -> Array | null + * TokenIterator.stepBackward() -> Array | null * * Tokenizes all the items from the current point to the row prior in the document. If the current point is at the top of the file, this function returns `null`. Otherwise, it returns an array of the tokenized strings. **/ @@ -89,7 +89,7 @@ var TokenIterator = function(session, initialRow, initialColumn) { }; /** - * Token_Iterator.stepForward() -> String | null + * TokenIterator.stepForward() -> String | null * * Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns `null`. Otherwise, it returns the tokenized string. **/ @@ -112,7 +112,7 @@ var TokenIterator = function(session, initialRow, initialColumn) { }; /** - * Token_Iterator.getCurrentToken() -> String + * TokenIterator.getCurrentToken() -> String * * Returns the current tokenized string. * @@ -122,7 +122,7 @@ var TokenIterator = function(session, initialRow, initialColumn) { }; /** - * Token_Iterator.getCurrentTokenRow() -> Number + * TokenIterator.getCurrentTokenRow() -> Number * * Returns the current row. * @@ -132,7 +132,7 @@ var TokenIterator = function(session, initialRow, initialColumn) { }; /** - * Token_Iterator.getCurrentTokenColumn() -> Number + * TokenIterator.getCurrentTokenColumn() -> Number * * Returns the current column. * diff --git a/lib/ace/virtual_renderer.js b/lib/ace/virtual_renderer.js index 47206a2d..5e59c680 100644 --- a/lib/ace/virtual_renderer.js +++ b/lib/ace/virtual_renderer.js @@ -57,14 +57,14 @@ var editorCss = require("ace/requirejs/text!./css/editor.css"); dom.importCssString(editorCss, "ace_editor"); /** - * class Virtual_Renderer + * class VirtualRenderer * * TODO * **/ /** - * new Virtual_Renderer(container, theme) + * new VirtualRenderer(container, theme) * - container (Editor): * - theme (String): The starting theme * @@ -192,7 +192,7 @@ var VirtualRenderer = function(container, theme) { oop.implement(this, EventEmitter); /** - * Virtual_Renderer.setSession(session) -> Void + * VirtualRenderer.setSession(session) -> Void * * Associates an [[EditSession `EditSession`]]. **/ @@ -207,7 +207,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateLines(firstRow, lastRow) -> Void + * VirtualRenderer.updateLines(firstRow, lastRow) -> Void * - firstRow (Number): The first row to update * - lastRow (Number): The last row to update * @@ -235,7 +235,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateText() -> Void + * VirtualRenderer.updateText() -> Void * * Triggers a full update of the text, for all the rows. **/ @@ -244,7 +244,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateFull() -> Void + * VirtualRenderer.updateFull() -> Void * * Triggers a full update of all the layers, for all the rows. **/ @@ -253,7 +253,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateFontSize() -> Void + * VirtualRenderer.updateFontSize() -> Void * * Updates the font size. **/ @@ -262,7 +262,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.onResize(force) -> Void + * VirtualRenderer.onResize(force) -> Void * - force (Boolean): TODO * * Triggers a resize of the editor. @@ -302,7 +302,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.adjustWrapLimit() -> Void + * VirtualRenderer.adjustWrapLimit() -> Void * * Adjusts the wrap limits. TODO. **/ @@ -313,7 +313,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setShowInvisibles(showInvisibles) -> Void + * VirtualRenderer.setShowInvisibles(showInvisibles) -> Void * - showInvisibles (Boolean): Set to `true` to show invisibles * * Identifies whether you want to show invisible characters or not. @@ -325,7 +325,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getShowInvisibles() -> Boolean + * VirtualRenderer.getShowInvisibles() -> Boolean * * Returns whether or not invisible characters are being shown or not. **/ @@ -336,7 +336,7 @@ var VirtualRenderer = function(container, theme) { this.$showPrintMargin = true; /** - * Virtual_Renderer.setShowPrintMargin(showPrintMargin) + * VirtualRenderer.setShowPrintMargin(showPrintMargin) * - showPrintMargin (Boolean): Set to `true` to show the print margin * * Identifies whether you want to show the print margin or not. @@ -348,7 +348,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getShowPrintMargin() -> Boolean + * VirtualRenderer.getShowPrintMargin() -> Boolean * * Returns whether or not the print margin is being shown or not. **/ @@ -359,7 +359,7 @@ var VirtualRenderer = function(container, theme) { this.$printMarginColumn = 80; /** - * Virtual_Renderer.setPrintMarginColumn(showPrintMargin) + * VirtualRenderer.setPrintMarginColumn(showPrintMargin) * - showPrintMargin (Boolean): Set to `true` to show the print margin column * * Identifies whether you want to show the print margin column or not. @@ -371,7 +371,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getPrintMarginColumn() -> Boolean + * VirtualRenderer.getPrintMarginColumn() -> Boolean * * Returns whether or not the print margin column is being shown or not. **/ @@ -380,7 +380,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getShowGutter() -> Boolean + * VirtualRenderer.getShowGutter() -> Boolean * * Returns `true` if the gutter is being shown. **/ @@ -389,7 +389,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setShowGutter(show) -> Void + * VirtualRenderer.setShowGutter(show) -> Void * - show (Boolean): Set to `true` to show the gutter * * Identifies whether you want to show the gutter or not. @@ -423,7 +423,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getContainerElement() -> TODO + * VirtualRenderer.getContainerElement() -> TODO * * TODO **/ @@ -432,7 +432,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getMouseEventTarget() -> TODO + * VirtualRenderer.getMouseEventTarget() -> TODO * * TODO **/ @@ -441,7 +441,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getTextAreaContainer() -> TODO + * VirtualRenderer.getTextAreaContainer() -> TODO * * TODO **/ @@ -450,7 +450,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.moveTextAreaToCursor(textarea) -> Void + * VirtualRenderer.moveTextAreaToCursor(textarea) -> Void * - textarea (Element): A text area to work with * * Changes the position of `textarea` to where the cursor is pointing. @@ -476,7 +476,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getFirstVisibleRow() -> Number + * VirtualRenderer.getFirstVisibleRow() -> Number * * [Returns the index of the first visible row.](~VirtualRenderer.getFirstVisibleRow) **/ @@ -485,7 +485,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getFirstFullyVisibleRow() -> Number + * VirtualRenderer.getFirstFullyVisibleRow() -> Number * * Returns the index of the first fully visible row. "Fully" here means TODO **/ @@ -494,7 +494,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getLastFullyVisibleRow() -> Number + * VirtualRenderer.getLastFullyVisibleRow() -> Number * * Returns the index of the last fully visible row. "Fully" here means TODO **/ @@ -504,7 +504,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getLastVisibleRow() -> Number + * VirtualRenderer.getLastVisibleRow() -> Number * * [Returns the index of the last visible row.](~VirtualRenderer.getLastVisibleRow) **/ @@ -515,7 +515,7 @@ var VirtualRenderer = function(container, theme) { this.$padding = null; /** - * Virtual_Renderer.setPadding(padding) -> Void + * VirtualRenderer.setPadding(padding) -> Void * - padding (Number): A new padding value (in pixels) * * Sets the padding for all the layers. @@ -532,7 +532,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getHScrollBarAlwaysVisible() -> Boolean + * VirtualRenderer.getHScrollBarAlwaysVisible() -> Boolean * * Returns whether or not the horizontal scrollbar is set to be always visible. **/ @@ -541,7 +541,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setHScrollBarAlwaysVisible(alwaysVisible) -> Void + * VirtualRenderer.setHScrollBarAlwaysVisible(alwaysVisible) -> Void * - alwaysVisible (Boolean): Set to `true` to make the horizontal scroll bar visible * * Identifies whether you want to show the horizontal scrollbar or not. @@ -740,7 +740,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateFrontMarkers() -> Void + * VirtualRenderer.updateFrontMarkers() -> Void * * TODO **/ @@ -750,7 +750,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateBackMarkers() -> Void + * VirtualRenderer.updateBackMarkers() -> Void * * TODO **/ @@ -760,7 +760,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.addGutterDecoration(row, className) -> Void + * VirtualRenderer.addGutterDecoration(row, className) -> Void * - row (Number): The row number * - className (String): The class to add * @@ -772,7 +772,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.removeGutterDecoration(row, className)-> Void + * VirtualRenderer.removeGutterDecoration(row, className)-> Void * - row (Number): The row number * - className (String): The class to add * @@ -784,7 +784,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setBreakpoints(rows) -> Void + * VirtualRenderer.setBreakpoints(rows) -> Void * - rows (Array): An array containg row numbers * * Sets a breakpoint for every row number indicated on `rows`. @@ -795,7 +795,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setAnnotations(annotations) -> Void + * VirtualRenderer.setAnnotations(annotations) -> Void * - annotations (Array): An array containing annotation * * TODO @@ -806,7 +806,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.updateCursor() -> Void + * VirtualRenderer.updateCursor() -> Void * * Updates the cursor icon. **/ @@ -815,7 +815,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.hideCursor() -> Void + * VirtualRenderer.hideCursor() -> Void * * Hides the cursor icon. **/ @@ -824,7 +824,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.showCursor() -> Void + * VirtualRenderer.showCursor() -> Void * * Shows the cursor icon. **/ @@ -833,7 +833,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.scrollCursorIntoView() -> VOid + * VirtualRenderer.scrollCursorIntoView() -> VOid * * TODO **/ @@ -869,7 +869,7 @@ var VirtualRenderer = function(container, theme) { }; /** related to: EditSession.getScrollTop - * Virtual_Renderer.getScrollTop() -> Number + * VirtualRenderer.getScrollTop() -> Number * * (~EditSession.getScrollTop) **/ @@ -878,7 +878,7 @@ var VirtualRenderer = function(container, theme) { }; /** related to: EditSession.getScrollLeft - * Virtual_Renderer.getScrollLeft() -> Number + * VirtualRenderer.getScrollLeft() -> Number * * (~EditSession.getScrollLeft) **/ @@ -887,7 +887,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getScrollTopRow() -> Number + * VirtualRenderer.getScrollTopRow() -> Number * * Returns the size of the first row, in pixels. TODO **/ @@ -896,7 +896,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getScrollBottomRow() -> Number + * VirtualRenderer.getScrollBottomRow() -> Number * * Returns the size of the last row, in pixels. **/ @@ -905,7 +905,7 @@ var VirtualRenderer = function(container, theme) { }; /** related to: EditSession.setScrollTop - * Virtual_Renderer.scrollToRow(row) -> Void + * VirtualRenderer.scrollToRow(row) -> Void * - row (Number): A row id * * Sets the top of the editor to the row indicated. @@ -915,7 +915,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.scrollToLine(line, center) + * VirtualRenderer.scrollToLine(line, center) * - line (Number): The line to go to * - center (Boolean): Identifies whether you want the cursor centered or not * @@ -932,7 +932,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.scrollToY(scrollTop) -> Number + * VirtualRenderer.scrollToY(scrollTop) -> Number * - scrollTop (Number): The position to scroll to * * Scrolls the editor to the y pixel indicated. @@ -948,7 +948,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.scrollToX(scrollLeft) -> Number + * VirtualRenderer.scrollToX(scrollLeft) -> Number * - scrollLeft (Number): The position to scroll to * * Scrolls the editor to the x pixel indicated. @@ -965,7 +965,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.scrollBy(deltaX, deltaY) -> Void + * VirtualRenderer.scrollBy(deltaX, deltaY) -> Void * - deltaX (Number): The x value to scroll by * - deltaY (Number): The y value to scroll by * @@ -977,7 +977,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.isScrollableBy(deltaX, deltaY) -> Boolean + * VirtualRenderer.isScrollableBy(deltaX, deltaY) -> Boolean * - deltaX (Number): The x value to scroll by * - deltaY (Number): The y value to scroll by * @@ -992,7 +992,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.screenToTextCoordinates(pageX, pageY) -> Number + * VirtualRenderer.screenToTextCoordinates(pageX, pageY) -> Number * * TODO **/ @@ -1010,7 +1010,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.textToScreenCoordinates(row, column) -> Object + * VirtualRenderer.textToScreenCoordinates(row, column) -> Object * * TODO **/ @@ -1028,7 +1028,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.visualizeFocus() -> Void + * VirtualRenderer.visualizeFocus() -> Void * * Focuses the current container. **/ @@ -1037,7 +1037,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.visualizeBlur() -> Void + * VirtualRenderer.visualizeBlur() -> Void * * Blurs the current container. **/ @@ -1046,7 +1046,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.showComposition(position) -> Void + * VirtualRenderer.showComposition(position) -> Void * * TODO **/ @@ -1069,7 +1069,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setCompositionText(text) -> Void + * VirtualRenderer.setCompositionText(text) -> Void * - text (String): A string of text to use * * Sets the inner text of the current composition to `text`. @@ -1079,7 +1079,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.hideComposition() -> Void + * VirtualRenderer.hideComposition() -> Void * * Hides the current composition. **/ @@ -1095,7 +1095,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.setTheme(theme) -> Void + * VirtualRenderer.setTheme(theme) -> Void * - theme (String): The path to a theme * * [Sets a new theme for the editor. `theme` should exist, and be a directory path, like `ace/theme/textmate`.](~VirtualRenderer.setTheme) @@ -1142,7 +1142,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.getTheme() -> String + * VirtualRenderer.getTheme() -> String * * [Returns the path of the current theme.](~VirtualRenderer.getTheme) **/ @@ -1155,7 +1155,7 @@ var VirtualRenderer = function(container, theme) { // a certain mode that editor is in. /** - * Virtual_Renderer.setStyle(style) -> Void + * VirtualRenderer.setStyle(style) -> Void * - style (String): A class name * * [Adds a new class, `style`, to the editor.](~VirtualRenderer.setStyle) @@ -1165,7 +1165,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.unsetStyle(style) -> Void + * VirtualRenderer.unsetStyle(style) -> Void * - style (String): A class name * * [Removes the class `style` from the editor.](~VirtualRenderer.unsetStyle) @@ -1175,7 +1175,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * Virtual_Renderer.destroy() + * VirtualRenderer.destroy() * * TODO **/