Continue layout work

This commit is contained in:
Garen Torikian 2012-04-24 17:29:26 -07:00
commit 2f36c2ee35
27 changed files with 265 additions and 302 deletions

View file

@ -2,7 +2,7 @@ var panino = require("panino");
var srcPath = process.cwd() + "/../lib/ace"; var srcPath = process.cwd() + "/../lib/ace";
panino.main(["--path=" + srcPath, "-o", "./out/", "-a", "./additionalObjs.json", "-t", "Ace API Documentation", "--skin", "./resources/ace/"], function(err) { panino.main(["--path=" + srcPath, "-o", "./out/", "-a", "./additionalObjs.json", "-t", "Ace API", "--skin", "./resources/ace/"], function(err) {
if (err) { if (err) {
console.error(err); console.error(err);
process.exit(-1); process.exit(-1);

View file

@ -3,10 +3,8 @@
*/ */
body { body {
min-width: 1010px; min-width: 1010px;
} color: #2D2D2D;
body { background: #EDF5FA url(../images/main_bg.png) 0 0 repeat;
background: #edf5fa url(../images/main_bg.png) 0 0 repeat;
color: #262626
} }
ul { ul {
@ -22,14 +20,6 @@ a, a:hover {
} }
code { code {
/* background-color: #fce68c;*/
/* font-size: 11px;
line-height: 16px;
font-family: 'Ubuntu Mono',Monaco,Consolas,monospace !important;
padding: 0;
*/
font-size: 12px; font-size: 12px;
line-height: 16px; line-height: 16px;
font-family: 'Ubuntu Mono',Monaco,Consolas,monospace !important; font-family: 'Ubuntu Mono',Monaco,Consolas,monospace !important;
@ -39,6 +29,7 @@ code {
display: inline-block; display: inline-block;
padding: 0 4px; padding: 0 4px;
margin: 2px 1px; margin: 2px 1px;
color: inherit;
} }
pre { pre {
@ -96,22 +87,8 @@ blockquote p{
Header and shoulders Header and shoulders
*/ */
#topSection { ul.topLinks {
margin: 0 auto; left: 290px;
width: 1000px;
position : relative;
}
#topSection .leftnav{
width : 286px;
}
#topSection .dropdown {
margin-right: 0px;
}
#topSection .versions {
margin-right: 0;
} }
.small_win #topSection { .small_win #topSection {
@ -149,30 +126,9 @@ a.brand {
.ace_logo { .ace_logo {
position: absolute; position: absolute;
top: 8px; top: 45px;
z-index: 20000; z-index: 20000;
left: 400px; left: 210px;
}
.masthead {
background: #000000 url(../images/header_back.png) repeat-x 0 bottom;
background-position-y: 70px;
}
.masthead .container {
width: 680px;
padding-left: 60px;
margin: 0 auto;
}
.jumbotron {
min-width: 1000px;
position: relative;
height: 200px;
top: -36px;
}
.jumbotron .inner {
padding: 45px 0;
padding-top: 75px;
} }
.c9-sponsor { .c9-sponsor {
@ -198,6 +154,12 @@ a.brand {
text-shadow: 0 1px 1px rgba(0, 0, 0, .3); text-shadow: 0 1px 1px rgba(0, 0, 0, .3);
} }
.headerTitle {
position: relative;
top: 100px;
left: 250px;
}
/* /*
Menu venue Menu venue
*/ */
@ -225,7 +187,7 @@ ul.menu {
/* need specificity to "beat" the above colors */ /* need specificity to "beat" the above colors */
.menu li .menu-item a.currentItem, .menuTwo li .menu-item { .menu li .menu-item a.currentItem, .menuTwo li .menu-item {
color: #618100; color: #0072bc;
} }
/* /*
@ -383,6 +345,11 @@ ul.menu {
.tabs a.menu:after, .tabs .dropdown-toggle:after { .tabs a.menu:after, .tabs .dropdown-toggle:after {
margin-top: 22px; margin-top: 22px;
} }
.dropdown .caret {
margin-top: 14px;
}
/*.backToMDN { /*.backToMDN {
position: absolute; position: absolute;
right: 0px; right: 0px;
@ -528,12 +495,26 @@ ul.tabs .double ul, ul.tabs .triple ul, ul.tabs .quad ul{
Center content (the "real stuff") Center content (the "real stuff")
*/ */
.content .container { .content .row {
background: url(../images/sidebar-border.png) repeat-y 95px 0; width: 1000px;
padding-bottom : 50px; margin-left: auto;
margin-right: auto;
} }
.container-fluid {
border-top: 1px solid #fffffe; .content .centerpiece {
background: url(../images/sidebar_border.png) repeat-y 180px 0;
padding-bottom: 50px;
}
header.filler {
position: relative;
background: #EDF5FA;
height: 50px;
width: 100%;
}
#container {
background: #edf5fa url(../images/main_bg.png) 0 0 repeat;
} }
/* /*
.container-fluid .row-fluid { .container-fluid .row-fluid {
@ -542,6 +523,10 @@ ul.tabs .double ul, ul.tabs .triple ul, ul.tabs .quad ul{
margin-right: auto; margin-right: auto;
}*/ }*/
.sidebarContainer {
margin-right: 25px;
}
#sidebar { #sidebar {
margin-top: 9px; margin-top: 9px;
/*background: url(../images/sidebar-border.png) repeat-y right 0;*/ /*background: url(../images/sidebar-border.png) repeat-y right 0;*/
@ -556,26 +541,24 @@ ul.tabs .double ul, ul.tabs .triple ul, ul.tabs .quad ul{
color: #404040; color: #404040;
} }
#sidebar #well #documentation {
#content {
padding-bottom: 10px; padding-bottom: 10px;
} }
#content article.article { #documentation article.article {
/* border-bottom: 1px solid #e9e9e9;*/ /* border-bottom: 1px solid #e9e9e9;*/
border-top: 1px solid #e9e9e9; border-top: 1px solid #e9e9e9;
padding: 16px 10px 2px; padding: 16px 10px 2px;
} }
div#content article:last-child { div#documentation article:last-child {
border-bottom: 1px solid #e9e9e9; border-bottom: 1px solid #e9e9e9;
padding-bottom: 40px; padding-bottom: 40px;
} }
#content article.article.methodToggleOpen { #documentation article.article.methodToggleOpen {
background: url(../images/method-bg.png) repeat 0 0; background: url(../images/method_bg.png) repeat 0 0;
margin : 0 0 10px 0; margin : 0 0 10px 0;
} }
#content article:first-child { #documentation article:first-child {
border:none; border:none;
} }
@ -689,7 +672,11 @@ li.signature {
cursor: pointer; cursor: pointer;
} }
.signature-call a { .signature-call a {
color: #859c59; color: #8e487e;
}
.sigClassName {
display: none;
} }
.eventObjName { .eventObjName {
@ -741,9 +728,6 @@ li.signature {
.alias:hover, .related-to:hover { .alias:hover, .related-to:hover {
opacity: 0.8; opacity: 0.8;
cursor: pointer; cursor: pointer;
}
.memberContent {
} }
.memberContent .title { .memberContent .title {
@ -806,9 +790,12 @@ table td, .bordered-table th + th, .bordered-table td + td, .bordered-table th +
.zebra-striped tbody tr:hover td, .zebra-striped tbody tr:hover th { .zebra-striped tbody tr:hover td, .zebra-striped tbody tr:hover th {
} }
.argument-list{ .argument-list {
margin-bottom : 13px; margin-bottom : 13px;
} }
.argName {
font-style: italic;
}
table td{ table td{
padding: 8px 10px 8px 10px; padding: 8px 10px 8px 10px;
@ -816,15 +803,19 @@ table td{
/* /*
Everyday I'm togglin' Everyday I'm togglin'
*/ */
#content h3 { .mainContent {
padding-top: 10px;
float: right
}
#documentation h3 {
font-size: 24px; font-size: 24px;
margin-top: 5px; margin-top: 5px;
/* margin: 10px 0;*/
} }
#content h3.methodToggle { #documentation h3.methodToggle {
margin: 0; margin: 0;
} }
#content h3.sectionHeader { #documentation h3.sectionHeader {
margin: 10px 0 17px 0; margin: 10px 0 17px 0;
line-height : 24px; line-height : 24px;
} }

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 629 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

View file

@ -48,6 +48,7 @@ $(function () {
// init prettyprint // init prettyprint
$('pre > code').addClass('prettyprint'); $('pre > code').addClass('prettyprint');
prettyPrint(); prettyPrint();
}); });
$(document).ready(function () { $(document).ready(function () {
@ -86,7 +87,7 @@ $(document).ready(function () {
var $classContent = $(this).closest('.classContent'); var $classContent = $(this).closest('.classContent');
$(this).scrollspy({ $(this).scrollspy({
min: $classContent.position().top - 55, min: $classContent.position().top,
max: $classContent.position().top + $classContent.height(), max: $classContent.position().top + $classContent.height(),
onEnter: function (element, position) { onEnter: function (element, position) {
var $pagination = $(element); var $pagination = $(element);
@ -135,7 +136,7 @@ $(document).ready(function () {
} }
}); });
}); });
$('span.methodClicker, article.article, h3.methodClicker').each(function () { $('span.methodClicker, article.article, h3.methodClicker').each(function () {
var a = $(this); var a = $(this);
var constructorPos = a.attr("id").indexOf("new "); var constructorPos = a.attr("id").indexOf("new ");

View file

@ -10,17 +10,18 @@ include lib
mixin head(title + " - " + fileName) mixin head(title + " - " + fileName)
body body
mixin navBar mixin navBar
mixin header header.filler
.container-fluid .container
.row-fluid .content
.span2.sidebarContainer .row.centerpiece
.span3.offset6.sidebarContainer
#sidebar #sidebar
include ace_menu.jade include ace_menu.jade
.span10 .span9.mainContent
#documentation #documentation
mixin api() mixin api()

View file

@ -141,12 +141,7 @@ mixin article(obj, parents)
-description = obj.description.substring(obj.short_description.length) // cut the short_desc out -description = obj.description.substring(obj.short_description.length) // cut the short_desc out
descArray = description.split("\n#### ") descArray = description.split("\n#### ")
if obj.arguments
h4 Arguments
!= argumentTable(obj.arguments, ["argument-list", "zebra-striped", "bordered-table"])
if descArray[0].length && descArray[0] !== '' && descArray[0] !== '\n' if descArray[0].length && descArray[0] !== '' && descArray[0] !== '\n'
h4 Description
mixin markdown(descArray[0]) mixin markdown(descArray[0])
if obj.bound && ~obj.bound.indexOf('#') if obj.bound && ~obj.bound.indexOf('#')
@ -160,15 +155,14 @@ mixin article(obj, parents)
!= link(obj.bound, ['link-short'], 'generic method') != link(obj.bound, ['link-short'], 'generic method')
|. If calling as generic, pass the instance in as the first argument. |. If calling as generic, pass the instance in as the first argument.
- var r; // Probably inefficient; we want the Returns section under the Arguments, no matter where in source it's defined if obj.arguments
- for (var a = 1; a < descArray.length; a++) h4 Arguments
if (descArray[a].indexOf("Returns") >= 0) != argumentTable(obj.arguments, ["argument-list", "table", "table-striped", "table-bordered"])
mixin markdown("\n#### " + descArray[a])
r = a
- for (var a = 1; a < descArray.length; a++)
if (a != r) if obj.retDesc
mixin markdown("\n#### " + descArray[a]) h4 Returns
!= returnTable(obj.retDesc, ["return-list", "table", "table-striped", "table-bordered"])
//- children //- children
for child in obj.children.filter(function(x){return x.type === 'section'}) for child in obj.children.filter(function(x){return x.type === 'section'})

View file

@ -36,25 +36,20 @@ mixin head(guideTitle, additionalCSS)
script(src="#{dirPrefix}resources/javascripts/jquery.collapse.js") script(src="#{dirPrefix}resources/javascripts/jquery.collapse.js")
script(src="#{dirPrefix}resources/javascripts/jquery.cookie.js") script(src="#{dirPrefix}resources/javascripts/jquery.cookie.js")
script(src="#{dirPrefix}resources/javascripts/bootstrap-dropdown.js") script(src="#{dirPrefix}resources/javascripts/bootstrap-dropdown.js")
script(src="#{dirPrefix}resources/javascripts/jquery-scrollspy.js")
script(script src="#{dirPrefix}resources/javascripts/prettify-extension.js")
mixin navBar mixin navBar
div.navbar.navbar-fixed-top div.navbar.navbar-fixed-top
div.navbar-inner div.navbar-inner
div.container div.container
ul.nav.topLinks
li#ace_site
a(href='http://ace.ajax.org') Ace
li#ace_api.active
a(href='http://ace.ajax.org/api') Ace API Reference
form(id='searchbox', action='', class='navbar-search pull-right') form(id='searchbox', action='', class='navbar-search pull-right')
input(class='span3', name='query', type='text', placeholder="Search Documentation", title="Search across all the documentation") input(class='search-query span3', name='query', type='text', placeholder="Search", title="Search across all the documentation")
mixin header
header.jumbotron.masthead#overview
div.ace_logo
a(href="http://ace.ajax.org")
img(src="#{dirPrefix}resources/images/ace_logo.png", alt="Ace Logo")
.container-fluid
.row-fluid
.span2
&nbsp;
.span10
h1 Ace API Reference
mixin footer mixin footer
footer#footer footer#footer
@ -67,7 +62,7 @@ mixin endingScripts
<script defer src="#{dirPrefix}resources/javascripts/plugins.js"></script> <script defer src="#{dirPrefix}resources/javascripts/plugins.js"></script>
<script defer src="#{dirPrefix}resources/javascripts/prettify.js"></script> <script defer src="#{dirPrefix}resources/javascripts/prettify.js"></script>
<script defer src="#{dirPrefix}resources/javascripts/prettify-extension.js"></script> <script defer src="#{dirPrefix}resources/javascripts/prettify-extension.js"></script>
<script defer src="#{dirPrefix}resources/javascripts/script.js"></script> <script defer src="#{dirPrefix}resources/javascripts/ux.js"></script>
<script defer src="#{dirPrefix}resources/javascripts/disqus-ext.js"></script> <script defer src="#{dirPrefix}resources/javascripts/disqus-ext.js"></script>
<script defer src="#{dirPrefix}resources/javascripts/ga.js"></script> <script defer src="#{dirPrefix}resources/javascripts/ga.js"></script>
//-<script defer src="tree.js"></script> //-<script defer src="tree.js"></script>
@ -84,26 +79,7 @@ mixin identifyBuild(tree, type)
-dirPrefix = './' -dirPrefix = './'
mixin markdown(text, inline) mixin markdown(text, inline)
html = markdown(text, inline) != markdown(text, inline)
!= restoreNotes(html)
-function restoreNotes(html)
-var noteORegex = new RegExp('<note>', "ig")
-var noteCRegex = new RegExp('</note>', "ig")
-var warningORegex = new RegExp('<warning>', "ig")
-var warningCRegex = new RegExp('</warning>', "ig")
if (html.match(noteORegex))
-html = html.replace(noteORegex, "<div class='alert-message block-message warning'>")
if (html.match(warningORegex))
-html = html.replace(warningORegex, "<div class='alert-message block-message error'>")
if (html.match(noteCRegex))
-html = html.replace(noteCRegex, "</div>")
if (html.match(warningCRegex))
-html = html.replace(warningCRegex, "</div>")
!= html
mixin formatGHHref(url, type) mixin formatGHHref(url, type)
url = url.substring(url.indexOf("src/") + 4) url = url.substring(url.indexOf("src/") + 4)

View file

@ -170,7 +170,7 @@ var Anchor = exports.Anchor = function(doc, row, column) {
}; };
/** /**
* Anchor.setPosition(row, column, noClip) -> Void * Anchor.setPosition(row, column, noClip)
* - row (Number): The row index to move the anchor to * - row (Number): The row index to move the anchor to
* - column (Number): The column index to move the anchor to * - column (Number): The column index to move the anchor to
* - noClip (Boolean): Identifies if you want the position to be clipped * - noClip (Boolean): Identifies if you want the position to be clipped
@ -219,7 +219,7 @@ var Anchor = exports.Anchor = function(doc, row, column) {
}; };
/** internal, hide /** internal, hide
* Anchor.clipPositionToDocument(row, column) -> Void * Anchor.clipPositionToDocument(row, column)
* - row (Number): The row index to clip the anchor to * - row (Number): The row index to clip the anchor to
* - column (Number): The column index to clip the anchor to * - column (Number): The column index to clip the anchor to
* *

View file

@ -100,7 +100,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
oop.implement(this, EventEmitter); oop.implement(this, EventEmitter);
/** /**
* BackgroundTokenizer.setTokenizer(tokenizer) -> Void * BackgroundTokenizer.setTokenizer(tokenizer)
* - tokenizer (Tokenizer): The new tokenizer to use * - tokenizer (Tokenizer): The new tokenizer to use
* *
* Sets a new tokenizer for this object. * Sets a new tokenizer for this object.
@ -115,7 +115,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
}; };
/** /**
* BackgroundTokenizer.setDocument(doc) -> Void * BackgroundTokenizer.setDocument(doc)
* - doc (Document): The new document to associate with * - doc (Document): The new document to associate with
* *
* Sets a new document to associate with this object. * Sets a new document to associate with this object.
@ -130,7 +130,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
}; };
/** /**
* BackgroundTokenizer.fireUpdateEvent(firstRow, lastRow) -> Void * BackgroundTokenizer.fireUpdateEvent(firstRow, lastRow)
* - firstRow (Number): The starting row region * - firstRow (Number): The starting row region
* - lastRow (Number): The final row region * - lastRow (Number): The final row region
* *
@ -147,7 +147,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
}; };
/** /**
* BackgroundTokenizer.start(startRow) -> Void * BackgroundTokenizer.start(startRow)
* - startRow (Number): The row to start at * - startRow (Number): The row to start at
* *
* Starts tokenizing at the row indicated. * Starts tokenizing at the row indicated.
@ -167,7 +167,7 @@ var BackgroundTokenizer = function(tokenizer, editor) {
}; };
/** /**
* BackgroundTokenizer.stop() -> Void * BackgroundTokenizer.stop()
* *
* Stops tokenizing. * Stops tokenizing.
* *

View file

@ -234,7 +234,7 @@ var Document = function(text) {
/** /**
* Document.getAllLines() -> Array * Document.getAllLines() -> Array
* *
* Returns all lines in the document as string array. <Warning>The caller should not modify this array!</Warning> * Returns all lines in the document as string array. Warning: The caller should not modify this array!
**/ **/
this.getAllLines = function() { this.getAllLines = function() {
return this.getLines(0, this.getLength()); return this.getLines(0, this.getLength());

View file

@ -105,7 +105,7 @@ var EditSession = function(text, mode) {
oop.implement(this, EventEmitter); oop.implement(this, EventEmitter);
/** /**
* EditSession.setDocument(doc) -> Void * EditSession.setDocument(doc)
* - doc (Document): The new `Document` to use * - doc (Document): The new `Document` to use
* *
* Sets the `EditSession` to point to a new `Document`. If a `BackgroundTokenizer` exists, it also points to `doc`. * Sets the `EditSession` to point to a new `Document`. If a `BackgroundTokenizer` exists, it also points to `doc`.
@ -136,7 +136,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$resetRowCache(row) -> Void * EditSession.$resetRowCache(row)
* - row (Number): The row to work with * - row (Number): The row to work with
* *
* *
@ -157,7 +157,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession@onChangeFold(e) -> Void * EditSession@onChangeFold(e)
* *
* Emitted when a code fold changes its state. * Emitted when a code fold changes its state.
* *
@ -168,7 +168,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession@onChange(e) -> Void * EditSession@onChange(e)
* *
* Emitted when the document changes. * Emitted when the document changes.
**/ **/
@ -196,7 +196,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setValue(text) -> Void * EditSession.setValue(text)
* - text (String): The new text to place * - text (String): The new text to place
* *
* Sets the session text. * Sets the session text.
@ -292,7 +292,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setUndoManager(undoManager) -> Void * EditSession.setUndoManager(undoManager)
* - undoManager (UndoManager): The new undo manager * - undoManager (UndoManager): The new undo manager
* *
* Sets the undo manager. * Sets the undo manager.
@ -310,7 +310,7 @@ var EditSession = function(text, mode) {
if (undoManager) { if (undoManager) {
var self = this; var self = this;
/** internal, hide /** internal, hide
* EditSession.$syncInformUndoManager() -> Void * EditSession.$syncInformUndoManager()
* *
* *
**/ **/
@ -377,7 +377,7 @@ var EditSession = function(text, mode) {
this.$useSoftTabs = true; this.$useSoftTabs = true;
/** /**
* EditSession.setUseSoftTabs(useSoftTabs) -> Void * EditSession.setUseSoftTabs(useSoftTabs)
* - useSoftTabs (Boolean): Value indicating whether or not to use soft tabs * - 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'`). * Pass `true` to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character (`'\t'`).
@ -401,7 +401,7 @@ var EditSession = function(text, mode) {
this.$tabSize = 4; this.$tabSize = 4;
/** /**
* EditSession.setTabSize(tabSize) -> Void * EditSession.setTabSize(tabSize)
* - tabSize (Number): The new tab size * - 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. * 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.
@ -435,7 +435,7 @@ var EditSession = function(text, mode) {
this.$overwrite = false; this.$overwrite = false;
/** /**
* EditSession.setOverwrite(overwrite) -> Void * EditSession.setOverwrite(overwrite)
* - overwrite (Boolean): Defines wheter or not to set overwrites * - 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. * 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.
@ -458,7 +458,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.toggleOverwrite() -> Void * EditSession.toggleOverwrite()
* *
* Sets the value of overwrite to the opposite of whatever it currently is. * Sets the value of overwrite to the opposite of whatever it currently is.
**/ **/
@ -476,7 +476,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setBreakpoints(rows) -> Void * EditSession.setBreakpoints(rows)
* - rows (Array): An array of row indicies * - rows (Array): An array of row indicies
* *
* Sets a breakpoint on every row number given by `rows`. This function also emites the `'changeBreakpoint'` event. * Sets a breakpoint on every row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
@ -491,7 +491,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.clearBreakpoints() -> Void * EditSession.clearBreakpoints()
* *
* Removes all breakpoints on the rows. This function also emites the `'changeBreakpoint'` event. * Removes all breakpoints on the rows. This function also emites the `'changeBreakpoint'` event.
**/ **/
@ -501,7 +501,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setBreakpoint(row) -> Void * EditSession.setBreakpoint(row)
* - row (Number): A row index * - row (Number): A row index
* *
* Sets a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event. * Sets a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
@ -512,7 +512,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.clearBreakpoint(row) -> Void * EditSession.clearBreakpoint(row)
* - row (Number): A row index * - row (Number): A row index
* *
* Removes a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event. * Removes a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
@ -555,7 +555,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.removeMarker(markerId) -> Void * EditSession.removeMarker(markerId)
* - markerId (Number): A number representing a marker * - 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. * 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.
@ -594,7 +594,7 @@ var EditSession = function(text, mode) {
* } * }
*/ */
/** /**
* EditSession.setAnnotations(annotations) -> Void * EditSession.setAnnotations(annotations)
* - annotations (Array): A list of annotations * - annotations (Array): A list of annotations
* *
* Sets annotations for the `EditSession`. This functions emits the `'changeAnnotation'` event. * Sets annotations for the `EditSession`. This functions emits the `'changeAnnotation'` event.
@ -622,7 +622,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.clearAnnotations() -> Void * EditSession.clearAnnotations()
* *
* Clears all the annotations for this session. This function also triggers the `'changeAnnotation'` event. * Clears all the annotations for this session. This function also triggers the `'changeAnnotation'` event.
**/ **/
@ -632,7 +632,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$detectNewLine(text) -> Void * EditSession.$detectNewLine(text)
* - text (String): A block of text * - text (String): A block of text
* *
* If `text` contains either the newline (`\n`) or carriage-return ('\r') characters, `$autoNewLine` stores that value. * If `text` contains either the newline (`\n`) or carriage-return ('\r') characters, `$autoNewLine` stores that value.
@ -704,7 +704,7 @@ var EditSession = function(text, mode) {
}; };
/** related to: Document.setNewLineMode /** related to: Document.setNewLineMode
* EditSession.setNewLineMode(newLineMode) -> Void * EditSession.setNewLineMode(newLineMode)
* - newLineMode (String): {:Document.setNewLineMode.param} * - newLineMode (String): {:Document.setNewLineMode.param}
* *
* {:Document.setNewLineMode.desc} * {:Document.setNewLineMode.desc}
@ -725,7 +725,7 @@ var EditSession = function(text, mode) {
this.$useWorker = true; this.$useWorker = true;
/** /**
* EditSession.setUseWorker(useWorker) -> Void * EditSession.setUseWorker(useWorker)
* - useWorker (Boolean): Set to `true` to use a worker * - useWorker (Boolean): Set to `true` to use a worker
* *
* Identifies if you want to use a worker for the `EditSession`. * Identifies if you want to use a worker for the `EditSession`.
@ -752,7 +752,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession@onReloadTokenizer(e) -> Void * EditSession@onReloadTokenizer(e)
* *
* 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. * 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.
**/ **/
@ -804,7 +804,7 @@ var EditSession = function(text, mode) {
this.$mode = null; this.$mode = null;
this.$origMode = null; this.$origMode = null;
/** /**
* EditSession.setMode(mode) -> Void * EditSession.setMode(mode)
* - mode (TextMode): Set a new text mode * - mode (TextMode): Set a new text mode
* *
* Sets a new text mode for the `EditSession`. This method also emits the `'changeMode'` event. If a [[BackgroundTokenizer `BackgroundTokenizer`]] is set, the `'tokenizerUpdate'` event is also emitted. * Sets a new text mode for the `EditSession`. This method also emits the `'changeMode'` event. If a [[BackgroundTokenizer `BackgroundTokenizer`]] is set, the `'tokenizerUpdate'` event is also emitted.
@ -863,7 +863,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.stopWorker() -> Void * EditSession.stopWorker()
* *
* *
**/ **/
@ -875,7 +875,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$startWorker() -> Void * EditSession.$startWorker()
* *
* *
**/ **/
@ -904,7 +904,7 @@ var EditSession = function(text, mode) {
this.$scrollTop = 0; this.$scrollTop = 0;
/** /**
* EditSession.setScrollTop(scrollTop) -> Void * EditSession.setScrollTop(scrollTop)
* - scrollTop (Number): The new scroll top value * - scrollTop (Number): The new scroll top value
* *
* This function sets the scroll top value. It also emits the `'changeScrollTop'` event. * This function sets the scroll top value. It also emits the `'changeScrollTop'` event.
@ -929,7 +929,7 @@ var EditSession = function(text, mode) {
this.$scrollLeft = 0; this.$scrollLeft = 0;
/** /**
* EditSession.setScrollLeft(scrollLeft) -> Void * EditSession.setScrollLeft(scrollLeft)
* *
* [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}
**/ **/
@ -1145,7 +1145,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setUndoSelect(enable) -> Void * EditSession.setUndoSelect(enable)
* - enable (Boolean): If `true`, selects the range of the reinserted change * - enable (Boolean): If `true`, selects the range of the reinserted change
* *
* ENables or disables highlighting of the range where an undo occured. * ENables or disables highlighting of the range where an undo occured.
@ -1281,7 +1281,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.indentRows(startRow, endRow, indentString) -> Void * EditSession.indentRows(startRow, endRow, indentString)
* - startRow (Number): Starting row * - startRow (Number): Starting row
* - endRow (Number): Ending row * - endRow (Number): Ending row
* - indentString (String): The indent token * - indentString (String): The indent token
@ -1298,7 +1298,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.outdentRows(range) -> Void * EditSession.outdentRows(range)
* - range (Range): A range of rows * - range (Range): A range of rows
* *
* Outdents all the rows defined by the `start` and `end` properties of `range`. * Outdents all the rows defined by the `start` and `end` properties of `range`.
@ -1458,7 +1458,7 @@ var EditSession = function(text, mode) {
}; };
/** /**
* EditSession.setUseWrapMode(useWrapMode) -> Void * EditSession.setUseWrapMode(useWrapMode)
* - useWrapMode (Boolean): Enable (or disable) wrap mode * - useWrapMode (Boolean): Enable (or disable) wrap mode
* *
* Sets whether or not line wrapping is enabled. If `useWrapMode` is different than the current value, the `'changeWrapMode'` event is emitted. * Sets whether or not line wrapping is enabled. If `useWrapMode` is different than the current value, the `'changeWrapMode'` event is emitted.
@ -1497,7 +1497,7 @@ var EditSession = function(text, mode) {
// in that direction. Or set both parameters to the same number to pin // in that direction. Or set both parameters to the same number to pin
// the limit to that value. // the limit to that value.
/** /**
* EditSession.setWrapLimitRange(min, max) -> Void * EditSession.setWrapLimitRange(min, max)
* - min (Number): The minimum wrap value (the left side wrap) * - min (Number): The minimum wrap value (the left side wrap)
* - max (Number): The maximum wrap value (the right side wrap) * - max (Number): The maximum wrap value (the right side wrap)
* *
@ -1535,7 +1535,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$constrainWrapLimit(wrapLimit) -> Void * EditSession.$constrainWrapLimit(wrapLimit)
* *
* *
**/ **/
@ -1578,7 +1578,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$updateInternalDataOnChange() -> Void * EditSession.$updateInternalDataOnChange()
* *
* *
**/ **/
@ -1698,7 +1698,7 @@ var EditSession = function(text, mode) {
}; };
/** internal, hide /** internal, hide
* EditSession.$updateWrapData(firstRow, lastRow) -> Void * EditSession.$updateWrapData(firstRow, lastRow)
* *
* *
**/ **/

View file

@ -103,7 +103,7 @@ var Editor = function(renderer, session) {
oop.implement(this, EventEmitter); oop.implement(this, EventEmitter);
/** /**
* Editor.setKeyboardHandler(keyboardHandler) -> Void * Editor.setKeyboardHandler(keyboardHandler)
* *
* Sets a new keyboard handler. * Sets a new keyboard handler.
**/ **/
@ -121,7 +121,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setSession(session) -> Void * Editor.setSession(session)
* - session (EditSession): The new session to use * - session (EditSession): The new session to use
* *
* Sets a new editsession to use. This method also emits the `'changeSession'` event. * Sets a new editsession to use. This method also emits the `'changeSession'` event.
@ -244,7 +244,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: VirtualRenderer.onResize /** related to: VirtualRenderer.onResize
* Editor.resize() -> Void * Editor.resize()
* *
* {:VirtualRenderer.onResize} * {:VirtualRenderer.onResize}
**/ **/
@ -253,7 +253,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setTheme(theme) -> Void * Editor.setTheme(theme)
* *
* {:VirtualRenderer.setTheme} * {:VirtualRenderer.setTheme}
**/ **/
@ -271,7 +271,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: VirtualRenderer.setStyle /** related to: VirtualRenderer.setStyle
* Editor.setStyle(style) -> Void * Editor.setStyle(style)
* *
* {:VirtualRenderer.setStyle} * {:VirtualRenderer.setStyle}
**/ **/
@ -280,7 +280,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: VirtualRenderer.unsetStyle /** related to: VirtualRenderer.unsetStyle
* Editor.unsetStyle(style) -> Void * Editor.unsetStyle(style)
* *
* {:VirtualRenderer.unsetStyle} * {:VirtualRenderer.unsetStyle}
**/ **/
@ -289,7 +289,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setFontSize(size) -> Void * Editor.setFontSize(size)
* - size (Number): A font size * - size (Number): A font size
* *
* Set a new font size (in pixels) for the editor text. * Set a new font size (in pixels) for the editor text.
@ -300,7 +300,7 @@ var Editor = function(renderer, session) {
}; };
/** internal, hide /** internal, hide
* Editor.$highlightBrackets() -> Void * Editor.$highlightBrackets()
* *
**/ **/
this.$highlightBrackets = function() { this.$highlightBrackets = function() {
@ -328,7 +328,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.focus() -> Void * Editor.focus()
* *
* Brings the current `textInput` into focus. * Brings the current `textInput` into focus.
**/ **/
@ -353,7 +353,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.blur() -> Void * Editor.blur()
* *
* Blurs the current `textInput`. * Blurs the current `textInput`.
**/ **/
@ -419,9 +419,9 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor@onScrollTopChange() -> Void * Editor@onScrollTopChange()
*
* *
* Emitted when the scroll top changes.
**/ **/
this.onScrollTopChange = function() { this.onScrollTopChange = function() {
this.renderer.scrollToY(this.session.getScrollTop()); this.renderer.scrollToY(this.session.getScrollTop());
@ -430,7 +430,7 @@ var Editor = function(renderer, session) {
/** /**
* Editor@onScrollLeftChange() * Editor@onScrollLeftChange()
* *
* * Emitted when the scroll left changes.
**/ **/
this.onScrollLeftChange = function() { this.onScrollLeftChange = function() {
this.renderer.scrollToX(this.session.getScrollLeft()); this.renderer.scrollToX(this.session.getScrollLeft());
@ -439,7 +439,7 @@ var Editor = function(renderer, session) {
/** /**
* Editor@onCursorChange() * Editor@onCursorChange()
* *
* * Emitted when the cursor changes.
**/ **/
this.onCursorChange = function() { this.onCursorChange = function() {
this.renderer.updateCursor(); this.renderer.updateCursor();
@ -616,7 +616,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.insert(text) -> Void * Editor.insert(text)
* - text (String): The new text to add * - text (String): The new text to add
* *
* Inserts `text` into wherever the cursor is pointing. * Inserts `text` into wherever the cursor is pointing.
@ -737,7 +737,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: EditSession.setOverwrite /** related to: EditSession.setOverwrite
* Editor.setOverwrite(overwrite) -> Void * Editor.setOverwrite(overwrite)
* - overwrite (Boolean): Defines wheter or not to set overwrites * - 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. * 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.
@ -757,7 +757,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: EditSession.toggleOverwrite /** related to: EditSession.toggleOverwrite
* Editor.toggleOverwrite() -> Void * Editor.toggleOverwrite()
* *
* Sets the value of overwrite to the opposite of whatever it currently is. * Sets the value of overwrite to the opposite of whatever it currently is.
**/ **/
@ -766,7 +766,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setScrollSpeed(speed) -> Void * Editor.setScrollSpeed(speed)
* - speed (Number): A value indicating the new speed * - speed (Number): A value indicating the new speed
* *
* Sets how fast the mouse scrolling should do. * Sets how fast the mouse scrolling should do.
@ -786,7 +786,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setDragDelay(dragDelay) -> Void * Editor.setDragDelay(dragDelay)
* - dragDelay (Number): A value indicating the new delay * - dragDelay (Number): A value indicating the new delay
* *
* Sets the delay (in milliseconds) of the mouse drag. * Sets the delay (in milliseconds) of the mouse drag.
@ -807,7 +807,7 @@ var Editor = function(renderer, session) {
this.$selectionStyle = "line"; this.$selectionStyle = "line";
/** /**
* Editor.setSelectionStyle(style) -> Void * Editor.setSelectionStyle(style)
* - style (String): The new selection style * - style (String): The new selection style
* *
* Indicates how selections should occur. By default, selections are set to "line". This function also emits the `'changeSelectionStyle'` event. * Indicates how selections should occur. By default, selections are set to "line". This function also emits the `'changeSelectionStyle'` event.
@ -833,7 +833,7 @@ var Editor = function(renderer, session) {
this.$highlightActiveLine = true; this.$highlightActiveLine = true;
/** /**
* Editor.setHighlightActiveLine(shouldHighlight) -> Void * Editor.setHighlightActiveLine(shouldHighlight)
* - shouldHighlight (Boolean): Set to `true` to highlight the current line * - shouldHighlight (Boolean): Set to `true` to highlight the current line
* *
* Determines whether or not the current line should be highlighted. * Determines whether or not the current line should be highlighted.
@ -857,7 +857,7 @@ var Editor = function(renderer, session) {
this.$highlightSelectedWord = true; this.$highlightSelectedWord = true;
/** /**
* Editor.setHighlightSelectedWord(shouldHighlight) -> Void * Editor.setHighlightSelectedWord(shouldHighlight)
* - shouldHighlight (Boolean): Set to `true` to highlight the currently selected word * - shouldHighlight (Boolean): Set to `true` to highlight the currently selected word
* *
* Determines if the currently selected word should be highlighted. * Determines if the currently selected word should be highlighted.
@ -883,7 +883,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setShowInvisibles(showInvisibles) -> Void * Editor.setShowInvisibles(showInvisibles)
* - showInvisibles (Boolean): Specifies whether or not to show invisible characters * - showInvisibles (Boolean): Specifies whether or not to show invisible characters
* *
* If `showInvisibiles` is set to `true`, invisible characters&mdash;like spaces or new lines&mdash;are show in the editor. * If `showInvisibiles` is set to `true`, invisible characters&mdash;like spaces or new lines&mdash;are show in the editor.
@ -905,7 +905,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setShowPrintMargin(showPrintMargin) -> Void * Editor.setShowPrintMargin(showPrintMargin)
* - showPrintMargin (Boolean): Specifies whether or not to show the print margin * - showPrintMargin (Boolean): Specifies whether or not to show the print margin
* *
* If `showPrintMargin` is set to `true`, the print margin is shown in the editor. * If `showPrintMargin` is set to `true`, the print margin is shown in the editor.
@ -924,7 +924,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setPrintMarginColumn(showPrintMargin) -> Void * Editor.setPrintMarginColumn(showPrintMargin)
* - showPrintMargin (Number): Specifies the new print margin * - showPrintMargin (Number): Specifies the new print margin
* *
* Sets the column defining where the print margin should be. * Sets the column defining where the print margin should be.
@ -945,7 +945,7 @@ var Editor = function(renderer, session) {
this.$readOnly = false; this.$readOnly = false;
/** /**
* Editor.setReadOnly(readOnly) -> Void * Editor.setReadOnly(readOnly)
* - readOnly (Boolean): Specifies whether the editor can be modified or not * - readOnly (Boolean): Specifies whether the editor can be modified or not
* *
* If `readOnly` is true, then the editor is set to read-only mode, and none of the content can change. * If `readOnly` is true, then the editor is set to read-only mode, and none of the content can change.
@ -966,7 +966,7 @@ var Editor = function(renderer, session) {
this.$modeBehaviours = true; this.$modeBehaviours = true;
/** /**
* Editor.setBehavioursEnabled() -> Void * Editor.setBehavioursEnabled()
* - 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}
@ -986,7 +986,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.setShowFoldWidgets(show) -> Void * Editor.setShowFoldWidgets(show)
* - show (Boolean): Specifies whether the fold widgets are shown * - show (Boolean): Specifies whether the fold widgets are shown
* *
* Indicates whether the fold widgets are shown or not. * Indicates whether the fold widgets are shown or not.
@ -1011,7 +1011,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.remove(dir) -> Void * Editor.remove(dir)
* - dir (String): The direction of the deletion to occur, either "left" or "right" * - dir (String): The direction of the deletion to occur, either "left" or "right"
* *
* Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace. * Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.
@ -1039,7 +1039,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.removeWordRight() -> Void * Editor.removeWordRight()
* *
* Removes the word directly to the right of the current selection. * Removes the word directly to the right of the current selection.
**/ **/
@ -1052,7 +1052,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.removeWordLeft() -> Void * Editor.removeWordLeft()
* *
* Removes the word directly to the left of the current selection. * Removes the word directly to the left of the current selection.
**/ **/
@ -1065,7 +1065,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.removeToLineStart() -> Void * Editor.removeToLineStart()
* *
* Removes all the words to the left of the current selection, until the start of the line. * Removes all the words to the left of the current selection, until the start of the line.
**/ **/
@ -1078,7 +1078,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.removeToLineEnd() -> Void * Editor.removeToLineEnd()
* *
* Removes all the words to the right of the current selection, until the end of the line. * Removes all the words to the right of the current selection, until the end of the line.
**/ **/
@ -1097,7 +1097,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.splitLine() -> Void * Editor.splitLine()
* *
* Splits the line at the current selection (by inserting an `'\n'`). * Splits the line at the current selection (by inserting an `'\n'`).
**/ **/
@ -1113,7 +1113,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.transposeLetters() -> Void * Editor.transposeLetters()
* *
* Transposes current line. * Transposes current line.
**/ **/
@ -1141,7 +1141,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.toLowerCase() -> Void * Editor.toLowerCase()
* *
* Converts the current selection entirely into lowercase. * Converts the current selection entirely into lowercase.
**/ **/
@ -1158,7 +1158,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.toUpperCase() -> Void * Editor.toUpperCase()
* *
* Converts the current selection entirely into uppercase. * Converts the current selection entirely into uppercase.
**/ **/
@ -1175,7 +1175,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: EditSession.indentRows /** related to: EditSession.indentRows
* Editor.indent() -> Void * Editor.indent()
* *
* Indents the current line. * Indents the current line.
**/ **/
@ -1203,7 +1203,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: EditSession.outdentRows /** related to: EditSession.outdentRows
* Editor.blockOutdent() -> Void * Editor.blockOutdent()
* *
* Outdents the current line. * Outdents the current line.
**/ **/
@ -1213,7 +1213,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.toggleCommentLines() -> Void * Editor.toggleCommentLines()
* *
* Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not). * Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).
**/ **/
@ -1224,7 +1224,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: EditSession.remove /** related to: EditSession.remove
* Editor.removeLines() -> Void * Editor.removeLines()
* *
* Removes all the lines in the current selection * Removes all the lines in the current selection
**/ **/
@ -1331,7 +1331,7 @@ var Editor = function(renderer, session) {
/** /**
* Editor.$moveLines(mover) -> Void * Editor.$moveLines(mover)
* - mover (Function): A method to call on each selected row * - mover (Function): A method to call on each selected row
* *
* Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicating them, or shifting them. * Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicating them, or shifting them.
@ -1465,7 +1465,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.selectPageDown() -> Void * Editor.selectPageDown()
* *
* Selects the text from the current position of the document until where a "page down" finishes. * Selects the text from the current position of the document until where a "page down" finishes.
**/ **/
@ -1481,7 +1481,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.selectPageUp() -> Void * Editor.selectPageUp()
* *
* Selects the text from the current position of the document until where a "page up" finishes. * Selects the text from the current position of the document until where a "page up" finishes.
**/ **/
@ -1498,7 +1498,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.gotoPageDown() -> Void * Editor.gotoPageDown()
* *
* Shifts the document to wherever "page down" is, as well as moving the cursor position. * Shifts the document to wherever "page down" is, as well as moving the cursor position.
**/ **/
@ -1511,7 +1511,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.gotoPageUp() -> Void * Editor.gotoPageUp()
* *
* Shifts the document to wherever "page up" is, as well as moving the cursor position. * Shifts the document to wherever "page up" is, as well as moving the cursor position.
**/ **/
@ -1524,7 +1524,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.scrollPageDown() -> Void * Editor.scrollPageDown()
* *
* Scrolls the document to wherever "page down" is, without changing the cursor position. * Scrolls the document to wherever "page down" is, without changing the cursor position.
**/ **/
@ -1533,7 +1533,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.scrollPageUp() -> Void * Editor.scrollPageUp()
* *
* Scrolls the document to wherever "page up" is, without changing the cursor position. * Scrolls the document to wherever "page up" is, without changing the cursor position.
**/ **/
@ -1542,7 +1542,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: VirtualRenderer.scrollToRow /** related to: VirtualRenderer.scrollToRow
* Editor.scrollToRow(row) -> Void * Editor.scrollToRow(row)
* - row (Number): The row to move to * - row (Number): The row to move to
* *
* Moves the editor to the specified row. * Moves the editor to the specified row.
@ -1553,7 +1553,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: VirtualRenderer.scrollToLine /** related to: VirtualRenderer.scrollToLine
* Editor.scrollToLine(line, center) -> Void * Editor.scrollToLine(line, center)
* - line (Number): The line to scroll to * - line (Number): The line to scroll to
* - center (Boolean): If `true` * - center (Boolean): If `true`
* *
@ -1564,7 +1564,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.centerSelection() -> Void * Editor.centerSelection()
* *
* Attempts to center the current selection on the screen. * Attempts to center the current selection on the screen.
**/ **/
@ -1610,7 +1610,7 @@ var Editor = function(renderer, session) {
/** related to: Selection.selectAll /** related to: Selection.selectAll
* Editor.selectAll() -> Void * Editor.selectAll()
* *
* Selects all the text in editor. * Selects all the text in editor.
**/ **/
@ -1621,7 +1621,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Selection.clearSelection /** related to: Selection.clearSelection
* Editor.clearSelection() -> Void * Editor.clearSelection()
* *
* {:Selection.clearSelection} * {:Selection.clearSelection}
**/ **/
@ -1630,7 +1630,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Selection.moveCursorTo /** related to: Selection.moveCursorTo
* Editor.moveCursorTo(row, column) -> Void * Editor.moveCursorTo(row, column)
* - row (Number): The new row number * - row (Number): The new row number
* - column (Number): The new column number * - column (Number): The new column number
* *
@ -1642,7 +1642,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Selection.moveCursorToPosition /** related to: Selection.moveCursorToPosition
* Editor.moveCursorToPosition(pos) -> Void * Editor.moveCursorToPosition(pos)
* - pos (Object): An object with two properties, row and column * - pos (Object): An object with two properties, row and column
* *
* Moves the cursor to the position indicated by `pos.row` and `pos.column`. * Moves the cursor to the position indicated by `pos.row` and `pos.column`.
@ -1653,7 +1653,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.jumpToMatching() -> Void * Editor.jumpToMatching()
* *
* Moves the cursor's row and column to the next matching bracket. * Moves the cursor's row and column to the next matching bracket.
* *
@ -1677,7 +1677,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.gotoLine(lineNumber, column) -> Void * Editor.gotoLine(lineNumber, column)
* - lineNumber (Number): The line number to go to * - lineNumber (Number): The line number to go to
* - column (Number): A column number to go to * - column (Number): A column number to go to
* *
@ -1696,7 +1696,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Editor.moveCursorTo /** related to: Editor.moveCursorTo
* Editor.navigateTo(row, column) -> Void * Editor.navigateTo(row, column)
* - row (Number): The new row number * - row (Number): The new row number
* - column (Number): The new column number * - column (Number): The new column number
* *
@ -1709,7 +1709,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateUp(times) -> Void * Editor.navigateUp(times)
* - times (Number): The number of times to change navigation * - times (Number): The number of times to change navigation
* *
* Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection. * Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.
@ -1721,7 +1721,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateDown(times) -> Void * Editor.navigateDown(times)
* - times (Number): The number of times to change navigation * - times (Number): The number of times to change navigation
* *
* Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection. * Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.
@ -1733,7 +1733,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateLeft(times) -> Void * Editor.navigateLeft(times)
* - times (Number): The number of times to change navigation * - times (Number): The number of times to change navigation
* *
* Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection. * Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.
@ -1753,7 +1753,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateRight(times) -> Void * Editor.navigateRight(times)
* - times (Number): The number of times to change navigation * - times (Number): The number of times to change navigation
* *
* Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection. * Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.
@ -1773,7 +1773,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateLineStart() -> Void * Editor.navigateLineStart()
* *
* Moves the cursor to the start of the current line. Note that this does de-select the current selection. * Moves the cursor to the start of the current line. Note that this does de-select the current selection.
**/ **/
@ -1783,7 +1783,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateLineEnd() -> Void * Editor.navigateLineEnd()
* *
* Moves the cursor to the end of the current line. Note that this does de-select the current selection. * Moves the cursor to the end of the current line. Note that this does de-select the current selection.
**/ **/
@ -1793,7 +1793,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateFileEnd() -> Void * Editor.navigateFileEnd()
* *
* Moves the cursor to the end of the current file. Note that this does de-select the current selection. * Moves the cursor to the end of the current file. Note that this does de-select the current selection.
**/ **/
@ -1803,7 +1803,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateFileStart() -> Void * Editor.navigateFileStart()
* *
* Moves the cursor to the start of the current file. Note that this does de-select the current selection. * Moves the cursor to the start of the current file. Note that this does de-select the current selection.
**/ **/
@ -1813,7 +1813,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateWordRight() -> Void * Editor.navigateWordRight()
* *
* Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection. * Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.
**/ **/
@ -1823,7 +1823,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.navigateWordLeft() -> Void * Editor.navigateWordLeft()
* *
* Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection. * Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.
**/ **/
@ -1833,7 +1833,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.replace(replacement, options) -> Void * Editor.replace(replacement, options)
* - replacement (String): The text to replace with * - replacement (String): The text to replace with
* - options (Object): The [[Search `Search`]] options to use * - options (Object): The [[Search `Search`]] options to use
* *
@ -1860,7 +1860,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.replaceAll(replacement, options) -> Void * Editor.replaceAll(replacement, options)
* - replacement (String): The text to replace with * - replacement (String): The text to replace with
* - options (Object): The [[Search `Search`]] options to use * - options (Object): The [[Search `Search`]] options to use
* *
@ -1915,7 +1915,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Search.find /** related to: Search.find
* Editor.find(needle, options) -> Void * Editor.find(needle, options)
* - needle (String): The text to search for * - needle (String): The text to search for
* - options (Object): An object defining various search properties * - options (Object): An object defining various search properties
* *
@ -1930,7 +1930,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Editor.find /** related to: Editor.find
* Editor.findNext(options) -> Void * Editor.findNext(options)
* *
* Performs another search for `needle` in the document. For more information on `options`, see [[Search `Search`]]. * Performs another search for `needle` in the document. For more information on `options`, see [[Search `Search`]].
**/ **/
@ -1943,7 +1943,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: Editor.find /** related to: Editor.find
* Editor.findPrevious(options) -> Void * Editor.findPrevious(options)
* *
* Performs a search for `needle` backwards. For more information on `options`, see [[Search `Search`]]. * Performs a search for `needle` backwards. For more information on `options`, see [[Search `Search`]].
**/ **/
@ -1986,7 +1986,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: UndoManager.undo /** related to: UndoManager.undo
* Editor.undo() -> Void * Editor.undo()
* *
* {:UndoManager.undo} * {:UndoManager.undo}
**/ **/
@ -1995,7 +1995,7 @@ var Editor = function(renderer, session) {
}; };
/** related to: UndoManager.redo /** related to: UndoManager.redo
* Editor.redo() -> Void * Editor.redo()
* *
* {:UndoManager.redo} * {:UndoManager.redo}
**/ **/
@ -2004,7 +2004,7 @@ var Editor = function(renderer, session) {
}; };
/** /**
* Editor.destroy() -> Void * Editor.destroy()
* *
* Cleans up the entire editor. * Cleans up the entire editor.
**/ **/

View file

@ -72,7 +72,7 @@ var EditSession = require("./edit_session").EditSession;
this.rangeList = null; this.rangeList = null;
/** /**
* Selection.addRange(range, $blockChangeEvents) -> Void * Selection.addRange(range, $blockChangeEvents)
* - range (Range): The new range to add * - range (Range): The new range to add
* - $blockChangeEvents (Boolean): Whether or not to block changing events * - $blockChangeEvents (Boolean): Whether or not to block changing events
* *
@ -135,7 +135,7 @@ var EditSession = require("./edit_session").EditSession;
}; };
/** /**
* Selection.mergeOverlappingRanges() -> Void * Selection.mergeOverlappingRanges()
* *
* merges overlapping ranges ensuring consistency after changes * merges overlapping ranges ensuring consistency after changes
**/ **/
@ -289,7 +289,7 @@ var EditSession = require("./edit_session").EditSession;
var Editor = require("./editor").Editor; var Editor = require("./editor").Editor;
(function() { (function() {
/** /**
* Editor.updateSelectionMarkers() -> Void * Editor.updateSelectionMarkers()
* *
* updates cursor and marker layers * updates cursor and marker layers
**/ **/
@ -317,7 +317,7 @@ var Editor = require("./editor").Editor;
}; };
/** /**
* Editor.removeSelectionMarker(range) -> Void * Editor.removeSelectionMarker(range)
* - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]]. * - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]].
* *
* Removes the selection marker. * Removes the selection marker.
@ -403,7 +403,7 @@ var Editor = require("./editor").Editor;
}; };
/** /**
* Editor.forEachSelection(cmd, args) -> Void * Editor.forEachSelection(cmd, args)
* - cmd (String): The command to execute * - cmd (String): The command to execute
* - args (String): Any arguments for the command * - args (String): Any arguments for the command
* *
@ -440,7 +440,7 @@ var Editor = require("./editor").Editor;
}; };
/** /**
* Editor.exitMultiSelectMode() -> Void * Editor.exitMultiSelectMode()
* *
* removes all selections except the last added one. * removes all selections except the last added one.
**/ **/
@ -504,7 +504,7 @@ var Editor = require("./editor").Editor;
// commands // commands
/** /**
* Editor.selectMoreLines(dir, skip) -> Void * Editor.selectMoreLines(dir, skip)
* - dir (Number): The direction of lines to select: -1 for up, 1 for down * - dir (Number): The direction of lines to select: -1 for up, 1 for down
* - skip (Boolean): If `true`, removes the active selection range * - skip (Boolean): If `true`, removes the active selection range
* *
@ -549,7 +549,7 @@ var Editor = require("./editor").Editor;
}; };
/** /**
* Editor.transposeSelections(dir) -> Void * Editor.transposeSelections(dir)
* - dir (Number): The direction to rotate selections * - dir (Number): The direction to rotate selections
* *
* Transposes the selected ranges. * Transposes the selected ranges.
@ -593,7 +593,7 @@ var Editor = require("./editor").Editor;
} }
/** /**
* Editor.selectMore(dir, skip) -> Void * Editor.selectMore(dir, skip)
* - dir (Number): The direction of lines to select: -1 for up, 1 for down * - dir (Number): The direction of lines to select: -1 for up, 1 for down
* - skip (Boolean): If `true`, removes the active selection range * - skip (Boolean): If `true`, removes the active selection range
* *
@ -665,7 +665,7 @@ exports.onSessionChange = function(e) {
}; };
/** /**
* MultiSelect(editor) -> Void * MultiSelect(editor)
* *
* adds multiple selection support to the editor * adds multiple selection support to the editor
* (note: should be called only once for each editor instance) * (note: should be called only once for each editor instance)

View file

@ -92,7 +92,7 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
oop.implement(this, EventEmitter); oop.implement(this, EventEmitter);
/** /**
* PlaceHolder.setup() -> Void * PlaceHolder.setup()
* *
* TODO * TODO
* *
@ -118,7 +118,7 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
}; };
/** /**
* PlaceHolder.showOtherMarkers() -> Void * PlaceHolder.showOtherMarkers()
* *
* TODO * TODO
* *
@ -138,7 +138,7 @@ var PlaceHolder = function(session, length, pos, others, mainClass, othersClass)
}; };
/** /**
* PlaceHolder.hideOtherMarkers() -> Void * PlaceHolder.hideOtherMarkers()
* *
* Hides all over markers in the [[EditSession `EditSession`]] that are not the currently selected one. * Hides all over markers in the [[EditSession `EditSession`]] that are not the currently selected one.
* *

View file

@ -232,7 +232,7 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
} }
/** /**
* Range.setStart(row, column) -> Void * Range.setStart(row, column)
* - row (Number): A row point to set * - row (Number): A row point to set
* - column (Number): A column point to set * - column (Number): A column point to set
* *
@ -250,7 +250,7 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
} }
/** /**
* Range.setEnd(row, column) -> Void * Range.setEnd(row, column)
* - row (Number): A row point to set * - row (Number): A row point to set
* - column (Number): A column point to set * - column (Number): A column point to set
* *

View file

@ -64,7 +64,7 @@ var RenderLoop = function(onRender, win) {
(function() { (function() {
/** internal, hide /** internal, hide
* RenderLoop.schedule(change) -> Void * RenderLoop.schedule(change)
* - change (Array): * - change (Array):
* *
* *

View file

@ -102,7 +102,7 @@ var ScrollBar = function(parent) {
}; };
/** /**
* ScrollBar.setHeight(height) -> Void * ScrollBar.setHeight(height)
* - height (Number): The new height * - height (Number): The new height
* *
* Sets the height of the scroll bar, in pixels. * Sets the height of the scroll bar, in pixels.
@ -113,7 +113,7 @@ var ScrollBar = function(parent) {
}; };
/** /**
* ScrollBar.setInnerHeight(height) -> Void * ScrollBar.setInnerHeight(height)
* - height (Number): The new inner height * - height (Number): The new inner height
* *
* Sets the inner height of the scroll bar, in pixels. * Sets the inner height of the scroll bar, in pixels.
@ -124,7 +124,7 @@ var ScrollBar = function(parent) {
}; };
/** /**
* ScrollBar.setScrollTop(scrollTop) -> Void * ScrollBar.setScrollTop(scrollTop)
* - scrollTop (Number): The new scroll top * - scrollTop (Number): The new scroll top
* *
* Sets the scroll top of the scroll bar. * Sets the scroll top of the scroll bar.

View file

@ -121,7 +121,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.setSelectionAnchor(row, column) -> Void * Selection.setSelectionAnchor(row, column)
* - row (Number): The new row * - row (Number): The new row
* - column (Number): The new column * - column (Number): The new column
* *
@ -159,7 +159,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.shiftSelection(columns) -> Void * Selection.shiftSelection(columns)
* - columns (Number): The number of columns to shift by * - columns (Number): The number of columns to shift by
* *
* Shifts the selection up (or down, if [[Selection.isBackwards `isBackwards()`]] is true) the given number of columns. * Shifts the selection up (or down, if [[Selection.isBackwards `isBackwards()`]] is true) the given number of columns.
@ -218,7 +218,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.clearSelection() -> Void * Selection.clearSelection()
* *
* [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}
**/ **/
@ -230,7 +230,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectAll() -> Void * Selection.selectAll()
* *
* Selects all the text in the document. * Selects all the text in the document.
**/ **/
@ -241,7 +241,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.setSelectionRange(range, reverse) -> Void * Selection.setSelectionRange(range, reverse)
* - range (Range): The range of text to select * - range (Range): The range of text to select
* - reverse (Boolean): Indicates if the range should go backwards (`true`) or not * - reverse (Boolean): Indicates if the range should go backwards (`true`) or not
* *
@ -268,7 +268,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectTo(row, column) -> Void * Selection.selectTo(row, column)
* - row (Number): The row to select to * - row (Number): The row to select to
* - column (Number): The column to select to * - column (Number): The column to select to
* *
@ -282,7 +282,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectToPosition(pos) -> Void * Selection.selectToPosition(pos)
* - pos (Object): An object containing the row and column * - pos (Object): An object containing the row and column
* *
* Moves the selection cursor to the row and column indicated by `pos`. * Moves the selection cursor to the row and column indicated by `pos`.
@ -295,7 +295,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectUp() -> Void * Selection.selectUp()
* *
* Moves the selection up one row. * Moves the selection up one row.
**/ **/
@ -304,7 +304,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectDown() -> Void * Selection.selectDown()
* *
* Moves the selection down one row. * Moves the selection down one row.
**/ **/
@ -313,7 +313,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectRight() -> Void * Selection.selectRight()
* *
* Moves the selection right one column. * Moves the selection right one column.
**/ **/
@ -322,7 +322,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectLeft() -> Void * Selection.selectLeft()
* *
* Moves the selection left one column. * Moves the selection left one column.
**/ **/
@ -331,7 +331,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectLineStart() -> Void * Selection.selectLineStart()
* *
* Moves the selection to the beginning of the current line. * Moves the selection to the beginning of the current line.
**/ **/
@ -340,7 +340,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectLineEnd() -> Void * Selection.selectLineEnd()
* *
* Moves the selection to the end of the current line. * Moves the selection to the end of the current line.
**/ **/
@ -349,7 +349,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectFileEnd() -> Void * Selection.selectFileEnd()
* *
* Moves the selection to the end of the file. * Moves the selection to the end of the file.
**/ **/
@ -358,7 +358,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectFileStart() -> Void * Selection.selectFileStart()
* *
* Moves the selection to the start of the file. * Moves the selection to the start of the file.
**/ **/
@ -367,7 +367,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectWordRight() -> Void * Selection.selectWordRight()
* *
* Moves the selection to the first word on the right. * Moves the selection to the first word on the right.
**/ **/
@ -376,7 +376,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectWordLeft() -> Void * Selection.selectWordLeft()
* *
* Moves the selection to the first word on the left. * Moves the selection to the first word on the left.
**/ **/
@ -385,7 +385,7 @@ var Selection = function(session) {
}; };
/** related to: EditSession.getWordRange /** related to: EditSession.getWordRange
* Selection.selectWord() -> Void * Selection.selectWord()
* *
* Moves the selection to highlight the entire word. * Moves the selection to highlight the entire word.
**/ **/
@ -396,7 +396,7 @@ var Selection = function(session) {
}; };
/** related to: EditSession.getAWordRange /** related to: EditSession.getAWordRange
* Selection.selectAWord() -> Void * Selection.selectAWord()
* *
* Selects a word, including its right whitespace. * Selects a word, including its right whitespace.
**/ **/
@ -407,7 +407,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.selectLine() -> Void * Selection.selectLine()
* *
* Selects the entire line. * Selects the entire line.
**/ **/
@ -429,7 +429,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorUp() -> Void * Selection.moveCursorUp()
* *
* Moves the cursor up one row. * Moves the cursor up one row.
**/ **/
@ -438,7 +438,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorDown() -> Void * Selection.moveCursorDown()
* *
* Moves the cursor down one row. * Moves the cursor down one row.
**/ **/
@ -447,7 +447,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorLeft() -> Void * Selection.moveCursorLeft()
* *
* Moves the cursor left one column. * Moves the cursor left one column.
**/ **/
@ -473,7 +473,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorRight() -> Void * Selection.moveCursorRight()
* *
* Moves the cursor right one column. * Moves the cursor right one column.
**/ **/
@ -499,7 +499,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorLineStart() -> Void * Selection.moveCursorLineStart()
* *
* Moves the cursor to the start of the line. * Moves the cursor to the start of the line.
**/ **/
@ -532,7 +532,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorLineEnd() -> Void * Selection.moveCursorLineEnd()
* *
* Moves the cursor to the end of the line. * Moves the cursor to the end of the line.
**/ **/
@ -547,7 +547,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorFileEnd() -> Void * Selection.moveCursorFileEnd()
* *
* Moves the cursor to the end of the file. * Moves the cursor to the end of the file.
**/ **/
@ -558,7 +558,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorFileStart() -> Void * Selection.moveCursorFileStart()
* *
* Moves the cursor to the start of the file. * Moves the cursor to the start of the file.
**/ **/
@ -567,7 +567,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorWordRight() -> Void * Selection.moveCursorWordRight()
* *
* Moves the cursor to the word on the right. * Moves the cursor to the word on the right.
**/ **/
@ -614,7 +614,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorWordLeft() -> Void * Selection.moveCursorWordLeft()
* *
* Moves the cursor to the word on the left. * Moves the cursor to the word on the left.
**/ **/
@ -665,7 +665,7 @@ var Selection = function(session) {
}; };
/** related to: EditSession.documentToScreenPosition /** related to: EditSession.documentToScreenPosition
* Selection.moveCursorBy(rows, chars) -> Void * Selection.moveCursorBy(rows, chars)
* - rows (Number): The number of rows to move by * - rows (Number): The number of rows to move by
* - chars (Number): The number of characters to move by * - chars (Number): The number of characters to move by
* *
@ -691,7 +691,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorToPosition(position) -> Void * Selection.moveCursorToPosition(position)
* - position (Object): The position to move to * - position (Object): The position to move to
* *
* Moves the selection to the position indicated by its `row` and `column`. * Moves the selection to the position indicated by its `row` and `column`.
@ -701,7 +701,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorTo(row, column, keepDesiredColumn) -> Void * Selection.moveCursorTo(row, column, keepDesiredColumn)
* - row (Number): The row to move to * - row (Number): The row to move to
* - column (Number): The column to move to * - column (Number): The column to move to
* - keepDesiredColumn (Boolean): [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool} * - keepDesiredColumn (Boolean): [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool}
@ -725,7 +725,7 @@ var Selection = function(session) {
}; };
/** /**
* Selection.moveCursorToScreen(row, column, keepDesiredColumn) -> Void * Selection.moveCursorToScreen(row, column, keepDesiredColumn)
* - row (Number): The row to move to * - row (Number): The row to move to
* - column (Number): The column to move to * - column (Number): The column to move to
* - keepDesiredColumn (Boolean): {:preventUpdateBool} * - keepDesiredColumn (Boolean): {:preventUpdateBool}