More design progress

This commit is contained in:
Garen Torikian 2012-04-24 01:45:41 -07:00
commit 775af73f64
22 changed files with 1142 additions and 3978 deletions

View file

@ -218,7 +218,7 @@ var Anchor = exports.Anchor = function(doc, row, column) {
this.document.removeEventListener("change", this.$onChange);
};
/** internal
/** internal, hide
* Anchor.clipPositionToDocument(row, column) -> Void
* - row (Number): The row index to clip the anchor to
* - column (Number): The column index to clip the anchor to

View file

@ -109,7 +109,7 @@ var Document = function(text) {
return new Anchor(this, row, column);
};
/** internal
/** internal, hide
* Document.$split(text) -> Array
* - text (String): The text to work with
*
@ -132,7 +132,7 @@ var Document = function(text) {
};
/** internal
/** internal, hide
* Document.$detectNewLine(text) -> Void
*
*
@ -269,7 +269,7 @@ var Document = function(text) {
}
};
/** internal
/** internal, hide
* Document.$clipPosition(position) -> Number
*
*

View file

@ -135,7 +135,7 @@ var EditSession = function(text, mode) {
return this.doc;
};
/** internal
/** internal, hide
* EditSession.$resetRowCache(row) -> Void
* - row (Number): The row to work with
*
@ -309,7 +309,7 @@ var EditSession = function(text, mode) {
if (undoManager) {
var self = this;
/** internal
/** internal, hide
* EditSession.$syncInformUndoManager() -> Void
*
*
@ -631,7 +631,7 @@ var EditSession = function(text, mode) {
this._emit("changeAnnotation", {});
};
/** internal
/** internal, hide
* EditSession.$detectNewLine(text) -> Void
* - text (String): A block of text
*
@ -862,7 +862,7 @@ var EditSession = function(text, mode) {
this._emit("changeMode");
};
/** internal
/** internal, hide
* EditSession.stopWorker() -> Void
*
*
@ -874,7 +874,7 @@ var EditSession = function(text, mode) {
this.$worker = null;
};
/** internal
/** internal, hide
* EditSession.$startWorker() -> Void
*
*
@ -1154,7 +1154,7 @@ var EditSession = function(text, mode) {
this.$undoSelect = enable;
};
/** internal
/** internal, hide
* EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange) -> Range
*
*
@ -1513,7 +1513,7 @@ var EditSession = function(text, mode) {
}
};
/** internal
/** internal, hide
* EditSession.adjustWrapLimit(desiredLimit) -> Boolean
* - desiredLimit (Number): The new wrap limit
*
@ -1534,7 +1534,7 @@ var EditSession = function(text, mode) {
return false;
};
/** internal
/** internal, hide
* EditSession.$constrainWrapLimit(wrapLimit) -> Void
*
*
@ -1577,7 +1577,7 @@ var EditSession = function(text, mode) {
};
};
/** internal
/** internal, hide
* EditSession.$updateInternalDataOnChange() -> Void
*
*
@ -1697,7 +1697,7 @@ var EditSession = function(text, mode) {
return removedFolds;
};
/** internal
/** internal, hide
* EditSession.$updateWrapData(firstRow, lastRow) -> Void
*
*
@ -1761,7 +1761,7 @@ var EditSession = function(text, mode) {
TAB = 11,
TAB_SPACE = 12;
/** internal
/** internal, hide
* EditSession.$computeWrapSplits(tokens, wrapLimit) -> Array
*
*
@ -1882,7 +1882,7 @@ var EditSession = function(text, mode) {
return splits;
}
/** internal
/** internal, hide
* EditSession.$getDisplayTokens(str, offset) -> Array
* - str (String): The string to check
* - offset (Number): The value to start at
@ -1920,7 +1920,7 @@ var EditSession = function(text, mode) {
return arr;
}
/** internal
/** internal, hide
* EditSession.$getStringScreenWidth(str, maxScreenColumn, screenColumn) -> Array
* - str (String): The string to calculate the screen width of
* - maxScreenColumn (Number):
@ -1991,7 +1991,7 @@ var EditSession = function(text, mode) {
return this.getRowLength(row) * config.lineHeight;
}
/** internal, related to: EditSession.documentToScreenColumn
/** internal, hide, related to: EditSession.documentToScreenColumn
* EditSession.getScreenLastRowColumn(screenRow) -> Number
* - screenRow (Number): The screen row to check
*
@ -2002,7 +2002,7 @@ var EditSession = function(text, mode) {
return this.documentToScreenColumn(pos.row, pos.column);
};
/** internal
/** internal, hide
* EditSession.getDocumentLastRowColumn(docRow, docColumn) -> Number
* - docRow (Number):
* - docColumn (Number):
@ -2013,7 +2013,7 @@ var EditSession = function(text, mode) {
return this.getScreenLastRowColumn(screenRow);
};
/** internal
/** internal, hide
* EditSession.getDocumentLastRowColumnPosition(docRow, docColumn) -> Number
*
**/
@ -2022,7 +2022,7 @@ var EditSession = function(text, mode) {
return this.screenToDocumentPosition(screenRow, Number.MAX_VALUE / 10);
};
/** internal
/** internal, hide
* EditSession.getRowSplitData(row) -> undefined | String
*
**/
@ -2044,7 +2044,7 @@ var EditSession = function(text, mode) {
return this.$tabSize - screenColumn % this.$tabSize;
};
/** internal
/** internal, hide
* EditSession.screenToDocumentRow(screenRow, screenColumn) -> Number
*
*
@ -2053,7 +2053,7 @@ var EditSession = function(text, mode) {
return this.screenToDocumentPosition(screenRow, screenColumn).row;
};
/** internal
/** internal, hide
* EditSession.screenToDocumentColumn(screenRow, screenColumn) -> Number
*
*
@ -2285,7 +2285,7 @@ var EditSession = function(text, mode) {
};
};
/** internal
/** internal, hide
* EditSession.documentToScreenColumn(row, docColumn) -> Number
*
*
@ -2294,7 +2294,7 @@ var EditSession = function(text, mode) {
return this.documentToScreenPosition(row, docColumn).column;
};
/** internal
/** internal, hide
* EditSession.documentToScreenRow(docRow, docColumn) -> Number
*
*

View file

@ -299,7 +299,7 @@ var Editor = function(renderer, session) {
this.renderer.updateFontSize();
};
/** internal
/** internal, hide
* Editor.$highlightBrackets() -> Void
*
**/
@ -456,7 +456,7 @@ var Editor = function(renderer, session) {
this.$updateHighlightActiveLine();
};
/** internal
/** internal, hide
* Editor.$updateHighlightActiveLine()
*
*
@ -1377,7 +1377,7 @@ var Editor = function(renderer, session) {
};
};
/** internal
/** internal, hide
* Editor@onCompositionStart(text)
* - text (String): The text being written
*
@ -1387,7 +1387,7 @@ var Editor = function(renderer, session) {
this.renderer.showComposition(this.getCursorPosition());
};
/** internal
/** internal, hide
* Editor@onCompositionUpdate(text)
* - text (String): The text being written
*
@ -1397,7 +1397,7 @@ var Editor = function(renderer, session) {
this.renderer.setCompositionText(text);
};
/** internal
/** internal, hide
* Editor@onCompositionEnd()
*
*

View file

@ -41,14 +41,14 @@ define(function(require, exports, module) {
var event = require("./lib/event");
/** internal
/** internal, hide
* class RenderLoop
*
* Batches changes (that force something to be redrawn) in the background.
*
**/
/** internal
/** internal, hide
* new RenderLoop(onRender, win)
*
*
@ -63,7 +63,7 @@ var RenderLoop = function(onRender, win) {
(function() {
/** internal
/** internal, hide
* RenderLoop.schedule(change) -> Void
* - change (Array):
*

View file

@ -192,7 +192,7 @@ Search.SELECTION = 2;
}
};
/** internal
/** internal, hide
* Search.$forwardMatchIterator(session) -> String | Boolean
* - session (EditSession): The session to search with
*
@ -233,7 +233,7 @@ Search.SELECTION = 2;
};
};
/** internal
/** internal, hide
* Search.$backwardMatchIterator(session) -> String | null
* - session (EditSession): The session to search with
*

View file

@ -47,14 +47,14 @@ var Editor = require("./editor").Editor;
var Renderer = require("./virtual_renderer").VirtualRenderer;
var EditSession = require("./edit_session").EditSession;
/** internal
/** internal, hide
* class Split
*
*
*
**/
/** internal
/** internal, hide
* new Split(container, theme, splits)
* - container (Document): The document to associate with the split
* - theme (String): The name of the initial theme
@ -104,7 +104,7 @@ var Split = function(container, theme, splits) {
return editor;
};
/** internal
/** internal, hide
* Split.setSplits(splits) -> Void
* - splits (Number): The new number of splits
*
@ -203,7 +203,7 @@ var Split = function(container, theme, splits) {
});
};
/** internal
/** internal, hide
* Split.setKeyboardHandler(keybinding) -> Void
* - keybinding (String):
*
@ -215,7 +215,7 @@ var Split = function(container, theme, splits) {
});
};
/** internal
/** internal, hide
* Split.forEach(callback, scope) -> Void
* - callback (Function): A callback function to execute
* - scope (String):
@ -303,7 +303,7 @@ var Split = function(container, theme, splits) {
return session;
};
/** internal
/** internal, hide
* Split.getOrientation() -> Number
*
* Returns the orientation.
@ -313,7 +313,7 @@ var Split = function(container, theme, splits) {
return this.$orientation;
};
/** internal
/** internal, hide
* Split.setOrientation(oriantation) -> Void
* - oriantation (Number):
*

View file

@ -1111,7 +1111,7 @@ var VirtualRenderer = function(container, theme) {
dom.removeCssClass(this.container, "ace_focus");
};
/** internal
/** internal, hide
* VirtualRenderer.showComposition(position) -> Void
* - position (Number):
*