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

One more update for API docs to not render so much rubbish, plus fixes

Browse source
This commit is contained in:
Garen Torikian 2012-08-28 16:54:40 -07:00
commit 0a14538bbe
21 changed files with 899 additions and 927 deletions
Download patch file Download diff file Expand all files Collapse all files

4
api/ace.html
View file

@ -3,8 +3,8 @@
<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--><html xmlns="http://www.w3.org/1999/xhtml"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><title>Ace - Ace API</title><meta name="generator" content="c9-doc-build"><meta name="description" content="Ace API documentation for the online code editor."><meta name="author" content="Garen J. Torikian"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="./resources/csses/bootstrap.min.css"><link rel="stylesheet" href="./resources/csses/prettify.css"><link rel="stylesheet" href="./resources/csses/ace_api.css"><link href="./resources/images/favicon.ico" rel="icon" type="image/x-icon"><script src="./resources/javascripts/jquery.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery.collapse.js"></script><script src="./resources/javascripts/jquery.cookie.js"></script><script src="./resources/javascripts/bootstrap-dropdown.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script script src="./resources/javascripts/prettify-extension.js"></script></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div id="topSection" class="container"><span class="brand"></span><ul class="nav topLinks"><li id="ace_site"><a href="../index.html">Ace</a></li><li id="ace_api" class="active"><a href="index.html">Ace API Reference</a></li></ul><form id="searchbox" action="" class="navbar-search pull-right"> <input name="query" type="text" placeholder="Search the API" title="Search across all the documentation" class="search-query span3"></form></div></div></div><div id="nonFooter"><div id="wrapper"><div class="content"><div class="row centerpiece"><div id="sidebarContainer" class="span3"><div id="sidebar"><div id="well"><h3>Ace Reference</h3><div class="swirl_divider"> </div><ul class="menu"><li><div class="menu-item"><a href="ace.html" class="menuLink namespace">Ace</a></div></li><li><div class="menu-item"><a href="anchor.html" class="menuLink namespace">Anchor</a></div></li><li><div class="menu-item"><a href="background_tokenizer.html" class="menuLink namespace">BackgroundTokenizer </a></div></li><li><div class="menu-item"><a href="document.html" class="menuLink namespace">Document </a></div></li><li><div class="menu-item"><a href="edit_session.html" class="menuLink namespace">EditSession </a></div></li><li><div class="menu-item"><a href="editor.html" class="menuLink namespace">Editor</a></div></li><li><div class="menu-item"><a href="range.html" class="menuLink namespace">Range</a></div></li><li><div class="menu-item"><a href="scrollbar.html" class="menuLink namespace">Scrollbar</a></div></li><li><div class="menu-item"><a href="search.html" class="menuLink namespace">Search </a></div></li><li><div class="menu-item"><a href="selection.html" class="menuLink namespace">Selection </a></div></li><li><div class="menu-item"><a href="token_iterator.html" class="menuLink namespace">TokenIterator</a></div></li><li><div class="menu-item"><a href="tokenizer.html" class="menuLink namespace">Tokenizer</a></div></li><li><div class="menu-item"><a href="undomanager.html" class="menuLink namespace">UndoManager</a></div></li><li><div class="menu-item"><a href="virtual_renderer.html" class="menuLink namespace">VirtualRenderer</a></div></li></ul></div></div></div><div id="mainContent" class="span9"><div id="documentation"><div class="classContent"><div class="membersBackground"></div><div class=" members pos0"><div class=" membersContent pos0"><h1 class="memberHeader"><span class="name">Ace<span class="editInC9"><a href='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git' title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><ul data-tabs="tabs" class="nav tabs pos0"><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li></ul></div></div><article id="Ace" data-title="Ace (class)" class="article"><div class="section description"><div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
</div></div></article><h3 class="sectionHeader">Methods</h3><article id="Ace.edit" data-title="Ace.edit (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Ace.edit" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">edit</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> el</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="editor.html#Editor" class="returnType " title="Editor (class)" data-id="Editor">Editor</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Ace.edit" class="ellipsis_description"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
</div><div id="short_Ace.edit" class="short_description hiddenSpan"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
</div><h3 id="Ace.edit" class="methodToggle methodClicker inactive">&nbsp;&nbsp;&nbsp;</h3><div class="description"><h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription ">Required. Either the id of an element, or the element itself</td></tr></table></div></div></div></div></article></div></div><div id="disqus_thread"></div></div></div></div></div><div class="push"></div></div><div id="footer"><div class="footerInner"><div class="footer-text pull-right"> <p><a href="http://www.c9.io">About Cloud9</a> | Ace & Cloud9 IDE are &copy; <a href="http://ajax.org">Ajax.org</a> 2012</p></div></div></div><!-- scripts concatenated and minified via ant build script--><script defer src="./resources/javascripts/plugins.js"></script>
</div><h3 id="Ace.edit" class="methodToggle methodClicker inactive">&nbsp;&nbsp;&nbsp;</h3><div class="description"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription ">Required. Either the id of an element, or the element itself</td></tr></table></div></div></div></div></article></div></div><div id="disqus_thread"></div></div></div></div></div><div class="push"></div></div><div id="footer"><div class="footerInner"><div class="footer-text pull-right"> <p><a href="http://www.c9.io">About Cloud9</a> | Ace & Cloud9 IDE are &copy; <a href="http://ajax.org">Ajax.org</a> 2012</p></div></div></div><!-- scripts concatenated and minified via ant build script--><script defer src="./resources/javascripts/plugins.js"></script>
<script defer src="./resources/javascripts/prettify.js"></script>
<script defer src="./resources/javascripts/prettify-extension.js"></script>
<script defer src="./resources/javascripts/ux.js"></script>

30
api/anchor.html
View file

File diff suppressed because one or more lines are too long

34
api/background_tokenizer.html
View file

File diff suppressed because one or more lines are too long

6
api/command_manager.html
View file

File diff suppressed because one or more lines are too long

98
api/document.html
View file

File diff suppressed because one or more lines are too long

336
api/edit_session.html
View file

File diff suppressed because one or more lines are too long

528
api/editor.html
View file

File diff suppressed because one or more lines are too long

34
api/placeholder.html
View file

File diff suppressed because one or more lines are too long

105
api/range.html
View file

File diff suppressed because one or more lines are too long

2
api/renderloop.html
View file

File diff suppressed because one or more lines are too long

26
api/scrollbar.html
View file

File diff suppressed because one or more lines are too long

55
api/search.html
View file

File diff suppressed because one or more lines are too long

186
api/selection.html
View file

File diff suppressed because one or more lines are too long

46
api/split.html
View file

File diff suppressed because one or more lines are too long

26
api/token_iterator.html
View file

File diff suppressed because one or more lines are too long

10
api/tokenizer.html
View file

File diff suppressed because one or more lines are too long

34
api/undomanager.html
View file

File diff suppressed because one or more lines are too long

234
api/virtual_renderer.html
View file

File diff suppressed because one or more lines are too long

13
doc/resources/ace/templates/lib.jade
View file

@ -128,21 +128,14 @@ mixin article(obj, parents)
div.sideToggler
if obj.short_description
div(id='ellipsis_#{obj.id}', class='ellipsis_description')
mixin markdown(obj.short_description)
div(id='short_#{obj.id}', class='short_description hiddenSpan')
mixin markdown(obj.description)
div(id='ellipsis_#{obj.id}', class='ellipsis_description')
mixin markdown(obj.short_description)
h3(id='#{obj.id}', class='methodToggle methodClicker inactive')
&nbsp;&nbsp;&nbsp;
div.description
-description = obj.description.substring(obj.short_description.length) // cut the short_desc out
descArray = description.split("\n#### ")
if descArray[0].length && descArray[0] !== '' && descArray[0] !== '\n'
mixin markdown(descArray[0])
mixin markdown(obj.description)
if obj.bound && ~obj.bound.indexOf('#')
p.note.methodized

18
lib/ace/search.js
View file

@ -56,15 +56,15 @@ var Range = require("./range").Range;
*
* Creates a new `Search` object. The following search options are avaliable:
*
* * needle: string or regular expression
* * backwards: false
* * wrap: false
* * caseSensitive: false
* * wholeWord: false
* * range: Range or null for whole document
* * regExp: false
* * start: Range or position
* * skipCurrent: false
* * `needle`: The string or regular expression you're looking for
* * `backwards`: Whether to search backwards from where cursor currently is. Defaults to `false`.
* * `wrap`: Whether to wrap the search back to the beginning when it hits the end. Defaults to `false`.
* * `caseSensitive`: Whether the search ought to be case-sensitive. Defaults to `false`.
* * `wholeWord`: Whether the search matches only on whole words. Defaults to `false`.
* * `range`: The [[Range]] to search within. Set this to `null` for the whole document
* * `regExp`: Whether the search is a regular expression or not. Defaults to `false`.
* * `start`: The starting [[Range]] or cursor position to begin the search
* * `skipCurrent`: Whether or not to include the current line in the search. Default to `false`.
*
**/

1
lib/ace/undomanager.js
View file

@ -63,6 +63,7 @@ var UndoManager = function() {
* - options (Object): Contains additional properties
*
* Provides a means for implementing your own undo manager. `options` has one property, `args`, an [[Array `Array`]], with two elements:
*
* * `args[0]` is an array of deltas
* * `args[1]` is the document to associate with
*