From 463fce04febb2d75b8dec001707496df7880f321 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Sat, 25 Feb 2012 10:33:28 -0800 Subject: [PATCH] Update js files based on new conref format --- lib/ace/background_tokenizer.js | 2 +- lib/ace/document.js | 8 ++++---- lib/ace/edit_session.js | 14 +++++++------- lib/ace/editor.js | 28 ++++++++++++++-------------- lib/ace/search.js | 2 +- lib/ace/selection.js | 4 ++-- lib/ace/undomanager.js | 4 ++-- lib/ace/virtual_renderer.js | 18 +++++++++--------- 8 files changed, 40 insertions(+), 40 deletions(-) diff --git a/lib/ace/background_tokenizer.js b/lib/ace/background_tokenizer.js index 2cc7309c..816719f6 100644 --- a/lib/ace/background_tokenizer.js +++ b/lib/ace/background_tokenizer.js @@ -198,7 +198,7 @@ var BackgroundTokenizer = function(tokenizer, editor) { * BackgroundTokenizer.getState(row) -> String * - 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} * **/ diff --git a/lib/ace/document.js b/lib/ace/document.js index b8a8d12c..fd4dae09 100644 --- a/lib/ace/document.js +++ b/lib/ace/document.js @@ -176,9 +176,9 @@ var Document = function(text) { this.$newLineMode = "auto"; /** * 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) { if (this.$newLineMode === newLineMode) @@ -190,7 +190,7 @@ var Document = function(text) { /** * 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() { @@ -253,7 +253,7 @@ var Document = function(text) { * Document.getTextRange(range) -> String * - 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) { if (range.start.row == range.end.row) { diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js index e6274b10..ae24b6ef 100644 --- a/lib/ace/edit_session.js +++ b/lib/ace/edit_session.js @@ -242,7 +242,7 @@ var EditSession = function(text, mode) { * EditSession.getState(row) -> Array * - row (Number): The row to start at * - * (~BackgroundTokenizer.getState) + * {:BackgroundTokenizer.getState} * **/ this.getState = function(row) { @@ -703,9 +703,9 @@ var EditSession = function(text, mode) { /** related to: Document.setNewLineMode * 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.doc.setNewLineMode(newLineMode); @@ -864,7 +864,7 @@ var EditSession = function(text, mode) { /** * 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() { return this.$scrollTop; @@ -874,7 +874,7 @@ var EditSession = function(text, mode) { /** * 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) { scrollLeft = Math.round(Math.max(0, scrollLeft)); @@ -888,7 +888,7 @@ var EditSession = function(text, mode) { /** * 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() { return this.$scrollLeft; @@ -989,7 +989,7 @@ var EditSession = function(text, mode) { * EditSession.getTextRange(range) -> Array * - range (String): The range to work with * - * (~Document.getTextRange.desc) + * {:Document.getTextRange.desc} **/ this.getTextRange = function(range) { return this.doc.getTextRange(range); diff --git a/lib/ace/editor.js b/lib/ace/editor.js index 45b14074..005a647d 100644 --- a/lib/ace/editor.js +++ b/lib/ace/editor.js @@ -246,7 +246,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.onResize * Editor.resize() -> Void * - * (~VirtualRenderer.onResize) + * {:VirtualRenderer.onResize} **/ this.resize = function() { this.renderer.onResize(); @@ -255,7 +255,7 @@ var Editor = function(renderer, session) { /** * Editor.setTheme(theme) -> Void * - * (~VirtualRenderer.setTheme) + * {:VirtualRenderer.setTheme} **/ this.setTheme = function(theme) { this.renderer.setTheme(theme); @@ -264,7 +264,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.getTheme * Editor.getTheme() -> String * - * (~VirtualRenderer.getTheme) + * {:VirtualRenderer.getTheme} **/ this.getTheme = function() { return this.renderer.getTheme(); @@ -273,7 +273,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.setStyle * Editor.setStyle(style) -> Void * - * (~VirtualRenderer.setStyle) + * {:VirtualRenderer.setStyle} **/ this.setStyle = function(style) { this.renderer.setStyle(style); @@ -282,7 +282,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.unsetStyle * Editor.unsetStyle(style) -> Void * - * (~VirtualRenderer.unsetStyle) + * {:VirtualRenderer.unsetStyle} **/ this.unsetStyle = function(style) { this.renderer.unsetStyle(style); @@ -971,7 +971,7 @@ var Editor = function(renderer, session) { * Editor.setBehavioursEnabled() -> Void * - 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.$modeBehaviours = enabled; @@ -980,7 +980,7 @@ var Editor = function(renderer, session) { /** * Editor.getBehavioursEnabled() -> Boolean * - * Returns `true` if the behaviors are currently enabled. (~BehaviorsDef) + * Returns `true` if the behaviors are currently enabled. {:BehaviorsDef} **/ this.getBehavioursEnabled = function () { @@ -1411,7 +1411,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.getFirstVisibleRow * Editor.getFirstVisibleRow() -> Number * - * (~VirtualRenderer.getFirstVisibleRow) + * {:VirtualRenderer.getFirstVisibleRow} **/ this.getFirstVisibleRow = function() { return this.renderer.getFirstVisibleRow(); @@ -1420,7 +1420,7 @@ var Editor = function(renderer, session) { /** related to: VirtualRenderer.getLastVisibleRow * Editor.getLastVisibleRow() -> Number * - * (~VirtualRenderer.getLastVisibleRow) + * {:VirtualRenderer.getLastVisibleRow} **/ this.getLastVisibleRow = function() { return this.renderer.getLastVisibleRow(); @@ -1604,7 +1604,7 @@ var Editor = function(renderer, session) { /** related to: Selection.getRange * Editor.getSelectionRange() -> Range * - * (~Selection.getRange) + * {:Selection.getRange} **/ this.getSelectionRange = function() { return this.selection.getRange(); @@ -1625,7 +1625,7 @@ var Editor = function(renderer, session) { /** related to: Selection.clearSelection * Editor.clearSelection() -> Void * - * (~Selection.clearSelection) + * {:Selection.clearSelection} **/ this.clearSelection = function() { this.selection.clearSelection(); @@ -1892,7 +1892,7 @@ var Editor = function(renderer, session) { /** related to: Search.getOptions * 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() { return this.$search.getOptions(); @@ -1956,7 +1956,7 @@ var Editor = function(renderer, session) { /** related to: UndoManager.undo * Editor.undo() -> Void * - * (~UndoManager.undo) + * {:UndoManager.undo} **/ this.undo = function() { this.session.getUndoManager().undo(); @@ -1965,7 +1965,7 @@ var Editor = function(renderer, session) { /** related to: UndoManager.redo * Editor.redo() -> Void * - * (~UndoManager.redo) + * {:UndoManager.redo} **/ this.redo = function() { this.session.getUndoManager().redo(); diff --git a/lib/ace/search.js b/lib/ace/search.js index 24b73989..1f52c55f 100644 --- a/lib/ace/search.js +++ b/lib/ace/search.js @@ -98,7 +98,7 @@ Search.SELECTION = 2; /** * 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() { diff --git a/lib/ace/selection.js b/lib/ace/selection.js index 36cad630..b6011098 100644 --- a/lib/ace/selection.js +++ b/lib/ace/selection.js @@ -200,7 +200,7 @@ var Selection = function(session) { /** * 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() { var anchor = this.selectionAnchor; @@ -220,7 +220,7 @@ var Selection = function(session) { /** * 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() { if (!this.$isEmpty) { diff --git a/lib/ace/undomanager.js b/lib/ace/undomanager.js index d7924adf..c457cf94 100644 --- a/lib/ace/undomanager.js +++ b/lib/ace/undomanager.js @@ -75,7 +75,7 @@ var UndoManager = function() { * UndoManager.undo(dontSelect) -> Range * - 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) { var deltas = this.$undoStack.pop(); @@ -92,7 +92,7 @@ var UndoManager = function() { * UndoManager.redo(dontSelect) -> Void * - 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) { var deltas = this.$redoStack.pop(); diff --git a/lib/ace/virtual_renderer.js b/lib/ace/virtual_renderer.js index b92280c5..8304bc7c 100644 --- a/lib/ace/virtual_renderer.js +++ b/lib/ace/virtual_renderer.js @@ -267,7 +267,7 @@ var VirtualRenderer = function(container, theme) { * VirtualRenderer.onResize(force) -> Void * - force (Boolean): TODO * - * [Triggers a resize of the editor.](~VirtualRenderer.onResize) + * [Triggers a resize of the editor.]{: #VirtualRenderer.onResize} **/ this.onResize = function(force) { var changes = this.CHANGE_SIZE; @@ -480,7 +480,7 @@ var VirtualRenderer = function(container, theme) { /** * 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() { return this.layerConfig.firstRow; @@ -508,7 +508,7 @@ var VirtualRenderer = function(container, theme) { /** * 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() { return this.layerConfig.lastRow; @@ -886,7 +886,7 @@ var VirtualRenderer = function(container, theme) { /** related to: EditSession.getScrollTop * VirtualRenderer.getScrollTop() -> Number * - * (~EditSession.getScrollTop) + * {:EditSession.getScrollTop} **/ this.getScrollTop = function() { return this.session.getScrollTop(); @@ -895,7 +895,7 @@ var VirtualRenderer = function(container, theme) { /** related to: EditSession.getScrollLeft * VirtualRenderer.getScrollLeft() -> Number * - * (~EditSession.getScrollLeft) + * {:EditSession.getScrollLeft} **/ this.getScrollLeft = function() { return this.session.getScrollLeft(); @@ -1112,7 +1112,7 @@ var VirtualRenderer = function(container, theme) { * 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) + * [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) { var _self = this; @@ -1158,7 +1158,7 @@ var VirtualRenderer = function(container, theme) { /** * VirtualRenderer.getTheme() -> String * - * [Returns the path of the current theme.](~VirtualRenderer.getTheme) + * [Returns the path of the current theme.]{: #VirtualRenderer.getTheme} **/ this.getTheme = function() { return this.$themeValue; @@ -1172,7 +1172,7 @@ var VirtualRenderer = function(container, theme) { * VirtualRenderer.setStyle(style) -> Void * - 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) { dom.addCssClass(this.container, style); @@ -1182,7 +1182,7 @@ var VirtualRenderer = function(container, theme) { * VirtualRenderer.unsetStyle(style) -> Void * - 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) { dom.removeCssClass(this.container, style);