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

Update js files based on new conref format

Browse source
This commit is contained in:
Garen Torikian 2012-02-25 10:33:28 -08:00
commit 463fce04fe
8 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/ace/background_tokenizer.js
View file

@ -198,7 +198,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
* BackgroundTokenizer.getState(row) -> String * BackgroundTokenizer.getState(row) -> String
* - row (Number): The row to start at * - row (Number): The row to start at
* *
* [Returns the state of tokenization for a row.](~BackgroundTokenizer.getState) * [Returns the state of tokenization for a row.]{: #BackgroundTokenizer.getState}
* *
**/ **/

8
lib/ace/document.js
View file

@ -176,9 +176,9 @@ var Document = function(text) {
this.$newLineMode = "auto"; this.$newLineMode = "auto";
/** /**
* Document.setNewLineMode(newLineMode) -> Void * Document.setNewLineMode(newLineMode) -> Void
* - newLineMode(String): [The newline mode to use; can be either `windows`, `unix`, or `auto`](~Document.setNewLineMode.param) * - newLineMode(String): [The newline mode to use; can be either `windows`, `unix`, or `auto`]{: #Document.setNewLineMode.param}
* *
* [Sets the new line mode.](~Document.setNewLineMode.desc) * [Sets the new line mode.]{: #Document.setNewLineMode.desc}
**/ **/
this.setNewLineMode = function(newLineMode) { this.setNewLineMode = function(newLineMode) {
if (this.$newLineMode === newLineMode) if (this.$newLineMode === newLineMode)
@ -190,7 +190,7 @@ var Document = function(text) {
/** /**
* Document.getNewLineMode() -> String * Document.getNewLineMode() -> String
* *
* [Returns the type of newlines being used; either `windows`, `unix`, or `auto`](~Document.getNewLineMode) * [Returns the type of newlines being used; either `windows`, `unix`, or `auto`]{: #Document.getNewLineMode}
* *
**/ **/
this.getNewLineMode = function() { this.getNewLineMode = function() {
@ -253,7 +253,7 @@ var Document = function(text) {
* Document.getTextRange(range) -> String * Document.getTextRange(range) -> String
* - range (Range): The range to work with * - range (Range): The range to work with
* *
* [Given a range within the document, this function returns all the text within that range as a single string.](~Document.getTextRange.desc) * [Given a range within the document, this function returns all the text within that range as a single string.]{: #Document.getTextRange.desc}
**/ **/
this.getTextRange = function(range) { this.getTextRange = function(range) {
if (range.start.row == range.end.row) { if (range.start.row == range.end.row) {

14
lib/ace/edit_session.js
View file

@ -242,7 +242,7 @@ var EditSession = function(text, mode) {
* EditSession.getState(row) -> Array * EditSession.getState(row) -> Array
* - row (Number): The row to start at * - row (Number): The row to start at
* *
* (~BackgroundTokenizer.getState) * {:BackgroundTokenizer.getState}
* *
**/ **/
this.getState = function(row) { this.getState = function(row) {
@ -703,9 +703,9 @@ var EditSession = function(text, mode) {
/** related to: Document.setNewLineMode /** related to: Document.setNewLineMode
* EditSession.setNewLineMode(newLineMode) -> Void * EditSession.setNewLineMode(newLineMode) -> Void
* - newLineMode (String): (~Document.setNewLineMode.param) * - newLineMode (String): {:Document.setNewLineMode.param}
* *
* (~Document.setNewLineMode.desc) * {:Document.setNewLineMode.desc}
**/ **/
this.setNewLineMode = function(newLineMode) { this.setNewLineMode = function(newLineMode) {
this.doc.setNewLineMode(newLineMode); this.doc.setNewLineMode(newLineMode);
@ -864,7 +864,7 @@ var EditSession = function(text, mode) {
/** /**
* EditSession.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) * [Returns the value of the distance between the top of the editor and the topmost part of the visible content.]{: #EditSession.getScrollTop}
**/ **/
this.getScrollTop = function() { this.getScrollTop = function() {
return this.$scrollTop; return this.$scrollTop;
@ -874,7 +874,7 @@ var EditSession = function(text, mode) {
/** /**
* EditSession.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) * [Sets the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.setScrollLeft}
**/ **/
this.setScrollLeft = function(scrollLeft) { this.setScrollLeft = function(scrollLeft) {
scrollLeft = Math.round(Math.max(0, scrollLeft)); scrollLeft = Math.round(Math.max(0, scrollLeft));
@ -888,7 +888,7 @@ var EditSession = function(text, mode) {
/** /**
* EditSession.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) * [Returns the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.getScrollLeft}
**/ **/
this.getScrollLeft = function() { this.getScrollLeft = function() {
return this.$scrollLeft; return this.$scrollLeft;
@ -989,7 +989,7 @@ var EditSession = function(text, mode) {
* EditSession.getTextRange(range) -> Array * EditSession.getTextRange(range) -> Array
* - range (String): The range to work with * - range (String): The range to work with
* *
* (~Document.getTextRange.desc) * {:Document.getTextRange.desc}
**/ **/
this.getTextRange = function(range) { this.getTextRange = function(range) {
return this.doc.getTextRange(range); return this.doc.getTextRange(range);

28
lib/ace/editor.js
View file

@ -246,7 +246,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.onResize /** related to: VirtualRenderer.onResize
* Editor.resize() -> Void * Editor.resize() -> Void
* *
* (~VirtualRenderer.onResize) * {:VirtualRenderer.onResize}
**/ **/
this.resize = function() { this.resize = function() {
this.renderer.onResize(); this.renderer.onResize();
@ -255,7 +255,7 @@ var Editor = function(renderer, session) {
/** /**
* Editor.setTheme(theme) -> Void * Editor.setTheme(theme) -> Void
* *
* (~VirtualRenderer.setTheme) * {:VirtualRenderer.setTheme}
**/ **/
this.setTheme = function(theme) { this.setTheme = function(theme) {
this.renderer.setTheme(theme); this.renderer.setTheme(theme);
@ -264,7 +264,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.getTheme /** related to: VirtualRenderer.getTheme
* Editor.getTheme() -> String * Editor.getTheme() -> String
* *
* (~VirtualRenderer.getTheme) * {:VirtualRenderer.getTheme}
**/ **/
this.getTheme = function() { this.getTheme = function() {
return this.renderer.getTheme(); return this.renderer.getTheme();
@ -273,7 +273,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.setStyle /** related to: VirtualRenderer.setStyle
* Editor.setStyle(style) -> Void * Editor.setStyle(style) -> Void
* *
* (~VirtualRenderer.setStyle) * {:VirtualRenderer.setStyle}
**/ **/
this.setStyle = function(style) { this.setStyle = function(style) {
this.renderer.setStyle(style); this.renderer.setStyle(style);
@ -282,7 +282,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.unsetStyle /** related to: VirtualRenderer.unsetStyle
* Editor.unsetStyle(style) -> Void * Editor.unsetStyle(style) -> Void
* *
* (~VirtualRenderer.unsetStyle) * {:VirtualRenderer.unsetStyle}
**/ **/
this.unsetStyle = function(style) { this.unsetStyle = function(style) {
this.renderer.unsetStyle(style); this.renderer.unsetStyle(style);
@ -971,7 +971,7 @@ var Editor = function(renderer, session) {
* Editor.setBehavioursEnabled() -> Void * Editor.setBehavioursEnabled() -> Void
* - enabled (Boolean): Enables or disables behaviors * - 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) * 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}
**/ **/
this.setBehavioursEnabled = function (enabled) { this.setBehavioursEnabled = function (enabled) {
this.$modeBehaviours = enabled; this.$modeBehaviours = enabled;
@ -980,7 +980,7 @@ var Editor = function(renderer, session) {
/** /**
* Editor.getBehavioursEnabled() -> Boolean * Editor.getBehavioursEnabled() -> Boolean
* *
* Returns `true` if the behaviors are currently enabled. (~BehaviorsDef) * Returns `true` if the behaviors are currently enabled. {:BehaviorsDef}
**/ **/
this.getBehavioursEnabled = function () { this.getBehavioursEnabled = function () {
@ -1411,7 +1411,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.getFirstVisibleRow /** related to: VirtualRenderer.getFirstVisibleRow
* Editor.getFirstVisibleRow() -> Number * Editor.getFirstVisibleRow() -> Number
* *
* (~VirtualRenderer.getFirstVisibleRow) * {:VirtualRenderer.getFirstVisibleRow}
**/ **/
this.getFirstVisibleRow = function() { this.getFirstVisibleRow = function() {
return this.renderer.getFirstVisibleRow(); return this.renderer.getFirstVisibleRow();
@ -1420,7 +1420,7 @@ var Editor = function(renderer, session) {
/** related to: VirtualRenderer.getLastVisibleRow /** related to: VirtualRenderer.getLastVisibleRow
* Editor.getLastVisibleRow() -> Number * Editor.getLastVisibleRow() -> Number
* *
* (~VirtualRenderer.getLastVisibleRow) * {:VirtualRenderer.getLastVisibleRow}
**/ **/
this.getLastVisibleRow = function() { this.getLastVisibleRow = function() {
return this.renderer.getLastVisibleRow(); return this.renderer.getLastVisibleRow();
@ -1604,7 +1604,7 @@ var Editor = function(renderer, session) {
/** related to: Selection.getRange /** related to: Selection.getRange
* Editor.getSelectionRange() -> Range * Editor.getSelectionRange() -> Range
* *
* (~Selection.getRange) * {:Selection.getRange}
**/ **/
this.getSelectionRange = function() { this.getSelectionRange = function() {
return this.selection.getRange(); return this.selection.getRange();
@ -1625,7 +1625,7 @@ var Editor = function(renderer, session) {
/** related to: Selection.clearSelection /** related to: Selection.clearSelection
* Editor.clearSelection() -> Void * Editor.clearSelection() -> Void
* *
* (~Selection.clearSelection) * {:Selection.clearSelection}
**/ **/
this.clearSelection = function() { this.clearSelection = function() {
this.selection.clearSelection(); this.selection.clearSelection();
@ -1892,7 +1892,7 @@ var Editor = function(renderer, session) {
/** related to: Search.getOptions /** related to: Search.getOptions
* Editor.getLastSearchOptions() -> Object * Editor.getLastSearchOptions() -> Object
* *
* (~Search.getOptions) For more information on `options`, see [[Search `Search`]]. * {:Search.getOptions} For more information on `options`, see [[Search `Search`]].
**/ **/
this.getLastSearchOptions = function() { this.getLastSearchOptions = function() {
return this.$search.getOptions(); return this.$search.getOptions();
@ -1956,7 +1956,7 @@ var Editor = function(renderer, session) {
/** related to: UndoManager.undo /** related to: UndoManager.undo
* Editor.undo() -> Void * Editor.undo() -> Void
* *
* (~UndoManager.undo) * {:UndoManager.undo}
**/ **/
this.undo = function() { this.undo = function() {
this.session.getUndoManager().undo(); this.session.getUndoManager().undo();
@ -1965,7 +1965,7 @@ var Editor = function(renderer, session) {
/** related to: UndoManager.redo /** related to: UndoManager.redo
* Editor.redo() -> Void * Editor.redo() -> Void
* *
* (~UndoManager.redo) * {:UndoManager.redo}
**/ **/
this.redo = function() { this.redo = function() {
this.session.getUndoManager().redo(); this.session.getUndoManager().redo();

2
lib/ace/search.js
View file

@ -98,7 +98,7 @@ Search.SELECTION = 2;
/** /**
* Search.getOptions() -> Object * Search.getOptions() -> Object
* *
* [Returns an object containing all the search options.](~Search.getOptions) * [Returns an object containing all the search options.]{: #Search.getOptions}
* *
**/ **/
this.getOptions = function() { this.getOptions = function() {

4
lib/ace/selection.js
View file

@ -200,7 +200,7 @@ var Selection = function(session) {
/** /**
* Selection.getRange() -> Range * Selection.getRange() -> Range
* *
* [Returns the [[Range `Range`]] for the selected text.](~Selection.getRange) * [Returns the [[Range `Range`]] for the selected text.]{: #Selection.getRange}
**/ **/
this.getRange = function() { this.getRange = function() {
var anchor = this.selectionAnchor; var anchor = this.selectionAnchor;
@ -220,7 +220,7 @@ var Selection = function(session) {
/** /**
* Selection.clearSelection() -> Void * Selection.clearSelection() -> Void
* *
* [Empties the selection (by de-selecting it). This function also emits the `'changeSelection'` event.](~Selection.clearSelection) * [Empties the selection (by de-selecting it). This function also emits the `'changeSelection'` event.]{: #Selection.clearSelection}
**/ **/
this.clearSelection = function() { this.clearSelection = function() {
if (!this.$isEmpty) { if (!this.$isEmpty) {

4
lib/ace/undomanager.js
View file

@ -75,7 +75,7 @@ var UndoManager = function() {
* UndoManager.undo(dontSelect) -> Range * UndoManager.undo(dontSelect) -> Range
* - dontSelect (Boolean): TODO * - dontSelect (Boolean): TODO
* *
* [Perform an undo operation on the document, reverting the last change. Returns the range of the undo.](~UndoManager.undo) * [Perform an undo operation on the document, reverting the last change. Returns the range of the undo.]{: #UndoManager.undo}
**/ **/
this.undo = function(dontSelect) { this.undo = function(dontSelect) {
var deltas = this.$undoStack.pop(); var deltas = this.$undoStack.pop();
@ -92,7 +92,7 @@ var UndoManager = function() {
* UndoManager.redo(dontSelect) -> Void * UndoManager.redo(dontSelect) -> Void
* - dontSelect (Boolean): TODO * - dontSelect (Boolean): TODO
* *
* [Perform a redo operation on the document, reimplementing the last change.](~UndoManager.redo) * [Perform a redo operation on the document, reimplementing the last change.]{: #UndoManager.redo}
**/ **/
this.redo = function(dontSelect) { this.redo = function(dontSelect) {
var deltas = this.$redoStack.pop(); var deltas = this.$redoStack.pop();

18
lib/ace/virtual_renderer.js
View file

@ -267,7 +267,7 @@ var VirtualRenderer = function(container, theme) {
* VirtualRenderer.onResize(force) -> Void * VirtualRenderer.onResize(force) -> Void
* - force (Boolean): TODO * - force (Boolean): TODO
* *
* [Triggers a resize of the editor.](~VirtualRenderer.onResize) * [Triggers a resize of the editor.]{: #VirtualRenderer.onResize}
**/ **/
this.onResize = function(force) { this.onResize = function(force) {
var changes = this.CHANGE_SIZE; var changes = this.CHANGE_SIZE;
@ -480,7 +480,7 @@ var VirtualRenderer = function(container, theme) {
/** /**
* VirtualRenderer.getFirstVisibleRow() -> Number * VirtualRenderer.getFirstVisibleRow() -> Number
* *
* [Returns the index of the first visible row.](~VirtualRenderer.getFirstVisibleRow) * [Returns the index of the first visible row.]{: #VirtualRenderer.getFirstVisibleRow}
**/ **/
this.getFirstVisibleRow = function() { this.getFirstVisibleRow = function() {
return this.layerConfig.firstRow; return this.layerConfig.firstRow;
@ -508,7 +508,7 @@ var VirtualRenderer = function(container, theme) {
/** /**
* VirtualRenderer.getLastVisibleRow() -> Number * VirtualRenderer.getLastVisibleRow() -> Number
* *
* [Returns the index of the last visible row.](~VirtualRenderer.getLastVisibleRow) * [Returns the index of the last visible row.]{: #VirtualRenderer.getLastVisibleRow}
**/ **/
this.getLastVisibleRow = function() { this.getLastVisibleRow = function() {
return this.layerConfig.lastRow; return this.layerConfig.lastRow;
@ -886,7 +886,7 @@ var VirtualRenderer = function(container, theme) {
/** related to: EditSession.getScrollTop /** related to: EditSession.getScrollTop
* VirtualRenderer.getScrollTop() -> Number * VirtualRenderer.getScrollTop() -> Number
* *
* (~EditSession.getScrollTop) * {:EditSession.getScrollTop}
**/ **/
this.getScrollTop = function() { this.getScrollTop = function() {
return this.session.getScrollTop(); return this.session.getScrollTop();
@ -895,7 +895,7 @@ var VirtualRenderer = function(container, theme) {
/** related to: EditSession.getScrollLeft /** related to: EditSession.getScrollLeft
* VirtualRenderer.getScrollLeft() -> Number * VirtualRenderer.getScrollLeft() -> Number
* *
* (~EditSession.getScrollLeft) * {:EditSession.getScrollLeft}
**/ **/
this.getScrollLeft = function() { this.getScrollLeft = function() {
return this.session.getScrollLeft(); return this.session.getScrollLeft();
@ -1112,7 +1112,7 @@ var VirtualRenderer = function(container, theme) {
* VirtualRenderer.setTheme(theme) -> Void * VirtualRenderer.setTheme(theme) -> Void
* - theme (String): The path to a theme * - 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) * [Sets a new theme for the editor. `theme` should exist, and be a directory path, like `ace/theme/textmate`.]{: #VirtualRenderer.setTheme}
**/ **/
this.setTheme = function(theme) { this.setTheme = function(theme) {
var _self = this; var _self = this;
@ -1158,7 +1158,7 @@ var VirtualRenderer = function(container, theme) {
/** /**
* VirtualRenderer.getTheme() -> String * VirtualRenderer.getTheme() -> String
* *
* [Returns the path of the current theme.](~VirtualRenderer.getTheme) * [Returns the path of the current theme.]{: #VirtualRenderer.getTheme}
**/ **/
this.getTheme = function() { this.getTheme = function() {
return this.$themeValue; return this.$themeValue;
@ -1172,7 +1172,7 @@ var VirtualRenderer = function(container, theme) {
* VirtualRenderer.setStyle(style) -> Void * VirtualRenderer.setStyle(style) -> Void
* - style (String): A class name * - style (String): A class name
* *
* [Adds a new class, `style`, to the editor.](~VirtualRenderer.setStyle) * [Adds a new class, `style`, to the editor.]{: #VirtualRenderer.setStyle}
**/ **/
this.setStyle = function setStyle(style) { this.setStyle = function setStyle(style) {
dom.addCssClass(this.container, style); dom.addCssClass(this.container, style);
@ -1182,7 +1182,7 @@ var VirtualRenderer = function(container, theme) {
* VirtualRenderer.unsetStyle(style) -> Void * VirtualRenderer.unsetStyle(style) -> Void
* - style (String): A class name * - style (String): A class name
* *
* [Removes the class `style` from the editor.](~VirtualRenderer.unsetStyle) * [Removes the class `style` from the editor.]{: #VirtualRenderer.unsetStyle}
**/ **/
this.unsetStyle = function unsetStyle(style) { this.unsetStyle = function unsetStyle(style) {
dom.removeCssClass(this.container, style); dom.removeCssClass(this.container, style);