-1,k={},l={},m,n;j?(l=e.position(),m=l.top,n=l.left):(m=parseFloat(h)||0,n=parseFloat(i)||0),f.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):e.css(k)}},f.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),d=cz.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(f.css(a,"marginTop"))||0,c.left-=parseFloat(f.css(a,"marginLeft"))||0,d.top+=parseFloat(f.css(b[0],"borderTopWidth"))||0,d.left+=parseFloat(f.css(b[0],"borderLeftWidth"))||0;return{top:c.top-d.top,left:c.left-d.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&!cz.test(a.nodeName)&&f.css(a,"position")==="static")a=a.offsetParent;return a})}}),f.each(["Left","Top"],function(a,c){var d="scroll"+c;f.fn[d]=function(c){var e,g;if(c===b){e=this[0];if(!e)return null;g=cA(e);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:f.support.boxModel&&g.document.documentElement[d]||g.document.body[d]:e[d]}return this.each(function(){g=cA(this),g?g.scrollTo(a?f(g).scrollLeft():c,a?c:f(g).scrollTop()):this[d]=c})}}),f.each(["Height","Width"],function(a,c){var d=c.toLowerCase();f.fn["inner"+c]=function(){var a=this[0];return a?a.style?parseFloat(f.css(a,d,"padding")):this[d]():null},f.fn["outer"+c]=function(a){var b=this[0];return b?b.style?parseFloat(f.css(b,d,a?"margin":"border")):this[d]():null},f.fn[d]=function(a){var e=this[0];if(!e)return a==null?null:this;if(f.isFunction(a))return this.each(function(b){var c=f(this);c[d](a.call(this,b,c[d]()))});if(f.isWindow(e)){var g=e.document.documentElement["client"+c],h=e.document.body;return e.document.compatMode==="CSS1Compat"&&g||h&&h["client"+c]||g}if(e.nodeType===9)return Math.max(e.documentElement["client"+c],e.body["scroll"+c],e.documentElement["scroll"+c],e.body["offset"+c],e.documentElement["offset"+c]);if(a===b){var i=f.css(e,d),j=parseFloat(i);return f.isNumeric(j)?j:i}return this.css(d,typeof a=="string"?a:a+"px")}}),a.jQuery=a.$=f})(window);
\ No newline at end of file
diff --git a/api/resources/javascripts/plugins.js b/api/resources/javascripts/plugins.js
deleted file mode 100644
index efda459c..00000000
--- a/api/resources/javascripts/plugins.js
+++ /dev/null
@@ -1,13 +0,0 @@
-window.log=function(){log.history=log.history||[];log.history.push(arguments);if(this.console){arguments.callee=arguments.callee.caller;var a=[].slice.call(arguments);(typeof console.log==="object"?log.apply.call(console.log,console,a):console.log.apply(console,a))}};
-(function(b){function c(){}for(var d="assert,count,debug,dir,dirxml,error,exception,group,groupCollapsed,groupEnd,info,log,timeStamp,profile,profileEnd,time,timeEnd,trace,warn".split(","),a;a=d.pop();){b[a]=b[a]||c}})((function(){try
-{console.log();return window.console;}catch(err){return window.console={};}})());
-
-/*
- * jQuery throttle / debounce - v1.1 - 3/7/2010
- * http://benalman.com/projects/jquery-throttle-debounce-plugin/
- *
- * Copyright (c) 2010 "Cowboy" Ben Alman
- * Dual licensed under the MIT and GPL licenses.
- * http://benalman.com/about/license/
- */
-(function(b,c){var $=b.jQuery||b.Cowboy||(b.Cowboy={}),a;$.throttle=a=function(e,f,j,i){var h,d=0;if(typeof f!=="boolean"){i=j;j=f;f=c}function g(){var o=this,m=+new Date()-d,n=arguments;function l(){d=+new Date();j.apply(o,n)}function k(){h=c}if(i&&!h){l()}h&&clearTimeout(h);if(i===c&&m>e){l()}else{if(f!==true){h=setTimeout(i?k:l,i===c?e-m:e)}}}if($.guid){g.guid=j.guid=j.guid||$.guid++}return g};$.debounce=function(d,e,f){return f===c?a(d,e,false):a(d,f,e!==false)}})(this);
diff --git a/api/resources/javascripts/prettify-extension.js b/api/resources/javascripts/prettify-extension.js
deleted file mode 100644
index ca8458dc..00000000
--- a/api/resources/javascripts/prettify-extension.js
+++ /dev/null
@@ -1,24 +0,0 @@
-// Stolen from StackOverflow. Find all
-// elements on the page and add the "prettyprint" style. If at least one
-// prettyprint element was found, call the Google Prettify prettyPrint() API.
-//http://sstatic.net/so/js/master.js?v=6523
-function styleCode()
-{
- if (typeof disableStyleCode != "undefined")
- {
- return;
- }
-
- var a = false;
-
- $("pre code").parent().each(function()
- {
- if (!$(this).hasClass("prettyprint"))
- {
- $(this).addClass("prettyprint");
- a = true
- }
- });
-
- if (a) { prettyPrint() }
-}
\ No newline at end of file
diff --git a/api/resources/javascripts/prettify.js b/api/resources/javascripts/prettify.js
deleted file mode 100644
index eef5ad7e..00000000
--- a/api/resources/javascripts/prettify.js
+++ /dev/null
@@ -1,28 +0,0 @@
-var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
-(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
-[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
-l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
-q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
-q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
-"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
-a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
-for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
-"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
-H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
-J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
-I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
-["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
-/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
-["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
-hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
-!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p 1010) sx = 1010 - document.documentElement.offsetWidth;
- }
- else sx = 0;
-
- $('.members').each(function (i) {
- var $classContent = $(this).closest('.classContent');
-
- $(this).scrollspy({
- min: $classContent.position().top + 5,
- max: $classContent.position().top + $classContent.height() - 35,
- onEnter: function (element, position) {
- var $pagination = $(element);
- var $paginationContent = $('.membersContent pos' + i);
- var $tabs = $('.tabs pos' + i);
-
- $paginationContent.css('left', -1 * sx);
- $paginationContent.css('top', 0);
-
- $pagination.addClass('shadow').stop().css({
- height: 31
- }).closest('.classContent').addClass('srolled');
-
- $tabs.addClass('tabsSansBorder');
- },
- onLeave: function (element, position) {
- var $pagination = $(element);
- var $paginationContent = $('.membersContent pos' + i);
- var $tabs = $('.tabs pos' + i);
-
- $paginationContent.stop().css({
- top: 11
- });
- $pagination.css({
- 'position': 'absolute',
- 'top': 193
- });
- $pagination.stop().removeClass('shadow').css({
- height: 42
- });
-
- $paginationContent.css('left', 0);
- // setTimeout(function () {
- $paginationContent.css({
- 'top': ''
- });
- $pagination.css({
- 'position': '',
- 'top': ''
- });
- $paginationContent.css('left', 0);
- $pagination.closest('.classContent').removeClass('srolled')
- $tabs.removeClass('tabsSansBorder');
- // }, 300);
- }
- });
- });
-
- $('span.methodClicker, article.article, i.methodClicker').each(function () {
- var a = $(this);
- var constructorPos = a.attr("id").indexOf("new ");
-
- var objName = a.attr("id");
- if (constructorPos >= 0) {
- objName = objName.substring(constructorPos + 4);
- objName += ".new";
- }
-
- a.attr("id", objName);
- });
-
- function showMethodContent() {
- var locationHash = location.hash.replace(/^#/, '').replace(/\./g, '\\.');
- var equalsPos = location.hash.indexOf("=");
-
- if (equalsPos >=0) {
- locationHash = locationHash.substring(0, location.hash.indexOf("="));
- }
-
- var $clickerEl = $('span#' + locationHash);
- if ($clickerEl.length > 0 && $clickerEl.hasClass('methodClicker')) {
- var p = $clickerEl.parent();
- p[0].force = true;
- p.trigger('click');
- p[0].force = false;
- }
- }
-
- if (location.hash.indexOf("section") >= 1) {
- showMethodContent();
- var data = location.hash;
- scrollTo(null, data.substr(1));
- }
-
- window.onhashchange = function () {
- showMethodContent();
- }
-};
-
-function scrollTo(el, data) {
- if (!data) {
- data = el.getAttribute("data-id");
- //location.hash = data;
- }
- var el = $("span#" + data.replace(/\./g, "\\."))[0];
- if (!el) return;
-
- var article = $(el).closest('.article')[0];
-
- var top = article.offsetTop - 100;
-
- if (document.body.scrollTop > top || document.body.scrollTop != top && document.body.scrollTop + (window.innerHeight || document.documentElement.offsetHeight) < top + article.offsetHeight) {
- $('body').animate({
- scrollTop: top
- }, {
- duration: 200,
- easing: "swing"
- });
- }
-}
\ No newline at end of file
diff --git a/api/scrollbar.html b/api/scrollbar.html
deleted file mode 100644
index 8ba5848c..00000000
--- a/api/scrollbar.html
+++ /dev/null
@@ -1,19 +0,0 @@
-A set of methods for setting and retrieving the editor's scrollbar.
-
Creates a new ScrollBar. parent is the owner of the scroll bar.
-
Arguments
- ScrollBar.on("scroll", function(Object e))
Emitted when the scroll bar, well, scrolls.
-
Arguments
| e | Object | Required. Contains one property, "data", which indicates the current scroll top position
- |
Returns the width of the scroll bar.
-
- ScrollBar.setHeight(Number height)
Sets the height of the scroll bar, in pixels.
-
Arguments
| height | Number | Required. The new height
- |
- ScrollBar.setInnerHeight(Number height)
Sets the inner height of the scroll bar, in pixels.
-
Arguments
| height | Number | Required. The new inner height
- |
- ScrollBar.setScrollTop(Number scrollTop)
Sets the scroll top of the scroll bar.
-
Arguments
| scrollTop | Number | Required. The new scroll top
- |
A class designed to handle all sorts of text searches within a Document.
-
Creates a new Search object. The following search options are avaliable:
-
Creates a new Search object. The following search options are avaliable:
-
-needle: The string or regular expression you're looking forbackwards: 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 documentregExp: Whether the search is a regular expression or not. Defaults to false.start: The starting Range or cursor position to begin the searchskipCurrent: Whether or not to include the current line in the search. Default to false.
-
Arguments
| session | EditSession | Required. The session to search with
- |
Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
-
Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
-
Arguments
| session | EditSession | Required. The session to search with
- |
Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.
-
Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.
-
Arguments
| session | EditSession | Required. The session to search with
- |
Returns an object containing all the search options.
-
Returns an object containing all the search options.
-
Searches for options.needle in input, and, if found, replaces it with replacement.
-
Searches for options.needle in input, and, if found, replaces it with replacement.
-
Arguments
| input | String | Required. The text to search in
- |
| replacement | String | Required. The replacing text
- |
Returns
| String | If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
-
-- If
options.needle was not found, this function returns null.
-
- |
Sets the search options via the options parameter.
-
Sets the search options via the options parameter.
-
Arguments
| options | Object | Required. An object containing all the new search properties
- |
Contains the cursor position and the text selection of an edit session.
-
The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.
-
Creates a new Selection object.
-
Creates a new Selection object.
-
Arguments
- Selection.on("changeCursor", function())
Emitted when the cursor position changes.
-
Emitted when the cursor position changes.
-
- Selection.on("changeSelection", function())
Emitted when the cursor selection changes.
-
Emitted when the cursor selection changes.
-
Adds a range to a selection by entering multiselect mode, if necessary.
-
Adds a range to a selection by entering multiselect mode, if necessary.
-
Arguments
| range | Range | Required. The new range to add
- |
| $blockChangeEvents | Boolean | Required. Whether or not to block changing events
- |
- Selection.clearSelection()
Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.
-
Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.
-
Gets the current position of the cursor.
-
Gets the current position of the cursor.
-
Returns the Range for the selected text.
-
Returns the Range for the selected text.
-
- Selection.getSelectionAnchor()
Returns an object containing the row and column of the calling selection anchor.
-
Returns an object containing the row and column of the calling selection anchor.
-
- Selection.getSelectionLead()
Returns an object containing the row and column of the calling selection lead.
-
Returns an object containing the row and column of the calling selection lead.
-
Returns true if the selection is going backwards in the document.
-
Returns true if the selection is going backwards in the document.
-
Returns true if the selection is empty.
-
Returns true if the selection is empty.
-
Returns true if the selection is a multi-line.
-
Returns true if the selection is a multi-line.
-
- Selection.mergeOverlappingRanges()
Merges overlapping ranges ensuring consistency after changes
-
Merges overlapping ranges ensuring consistency after changes
-
Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
-
Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
-
Arguments
| rows | Number | Required. The number of rows to move by
- |
| chars | Number | Required. The number of characters to move by
- |
- Selection.moveCursorDown()
Moves the cursor down one row.
-
Moves the cursor down one row.
-
- Selection.moveCursorFileEnd()
Moves the cursor to the end of the file.
-
Moves the cursor to the end of the file.
-
- Selection.moveCursorFileStart()
Moves the cursor to the start of the file.
-
Moves the cursor to the start of the file.
-
- Selection.moveCursorLeft()
Moves the cursor left one column.
-
Moves the cursor left one column.
-
- Selection.moveCursorLineEnd()
Moves the cursor to the end of the line.
-
Moves the cursor to the end of the line.
-
- Selection.moveCursorLineStart()
Moves the cursor to the start of the line.
-
Moves the cursor to the start of the line.
-
- Selection.moveCursorLongWordLeft()
Moves the cursor to the word on the left.
-
Moves the cursor to the word on the left.
-
- Selection.moveCursorLongWordRight()
Moves the cursor to the word on the right.
-
Moves the cursor to the word on the right.
-
- Selection.moveCursorRight()
Moves the cursor right one column.
-
Moves the cursor right one column.
-
Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
-
Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
-
Arguments
| row | Number | Required. The row to move to
- |
| column | Number | Required. The column to move to
- |
| keepDesiredColumn | Boolean | Required. If true, the cursor move does not respect the previous column
- |
- Selection.moveCursorToPosition(Object position)
Moves the selection to the position indicated by its row and column.
-
Moves the selection to the position indicated by its row and column.
-
Arguments
| position | Object | Required. The position to move to
- |
Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
-
Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
-
Arguments
| row | Number | Required. The row to move to
- |
| column | Number | Required. The column to move to
- |
| keepDesiredColumn | Boolean | Required. If true, the cursor move does not respect the previous column
- |
Moves the cursor up one row.
-
Moves the cursor up one row.
-
- Selection.rectangularRangeBlock(Cursor screenCursor, Anchor screenAnchor, Boolean includeEmptyLines)
Gets list of ranges composing rectangular block on the screen
-
Gets list of ranges composing rectangular block on the screen
-
Arguments
| screenCursor | Cursor | Required. The cursor to use
- |
| screenAnchor | Anchor | Required. The anchor to use
- |
| includeEmptyLines | Boolean | Required. If true, this includes ranges inside the block which are empty due to clipping
- |
Selects all the text in the document.
-
Selects all the text in the document.
-
Selects a word, including its right whitespace.
-
Selects a word, including its right whitespace.
-
Moves the selection down one row.
-
Moves the selection down one row.
-
- Selection.selectFileEnd()
Moves the selection to the end of the file.
-
Moves the selection to the end of the file.
-
- Selection.selectFileStart()
Moves the selection to the start of the file.
-
Moves the selection to the start of the file.
-
Moves the selection left one column.
-
Moves the selection left one column.
-
Selects the entire line.
-
Selects the entire line.
-
- Selection.selectLineEnd()
Moves the selection to the end of the current line.
-
Moves the selection to the end of the current line.
-
- Selection.selectLineStart()
Moves the selection to the beginning of the current line.
-
Moves the selection to the beginning of the current line.
-
Moves the selection right one column.
-
Moves the selection right one column.
-
Moves the selection cursor to the indicated row and column.
-
Moves the selection cursor to the indicated row and column.
-
Arguments
| row | Number | Required. The row to select to
- |
| column | Number | Required. The column to select to
- |
- Selection.selectToPosition(Object pos)
Moves the selection cursor to the row and column indicated by pos.
-
Moves the selection cursor to the row and column indicated by pos.
-
Arguments
| pos | Object | Required. An object containing the row and column
- |
Moves the selection up one row.
-
Moves the selection up one row.
-
Moves the selection to highlight the entire word.
-
Moves the selection to highlight the entire word.
-
- Selection.selectWordLeft()
Moves the selection to the first word on the left.
-
Moves the selection to the first word on the left.
-
- Selection.selectWordRight()
Moves the selection to the first word on the right.
-
Moves the selection to the first word on the right.
-
Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.
-
Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.
-
Arguments
| row | Number | Required. The new row
- |
| column | Number | Required. The new column
- |
Sets the selection to the provided range.
-
Sets the selection to the provided range.
-
Arguments
| range | Range | Required. The range of text to select
- |
| reverse | Boolean | Required. Indicates if the range should go backwards (true) or not
- |
- Selection.shiftSelection(Number columns)
Shifts the selection up (or down, if isBackwards() is true) the given number of columns.
-
Shifts the selection up (or down, if isBackwards() is true) the given number of columns.
-
Arguments
| columns | Number | Required. The number of columns to shift by
- |
- Selection.substractPoint(Range pos)
Removes a Range containing pos (if it exists).
-
Removes a Range containing pos (if it exists).
-
Arguments
| pos | Range | Required. The position to remove, as a {row, column} object
- |
Arguments
| container | Document | Required. The document to associate with the split
- |
| theme | String | Required. The name of the initial theme
- |
| splits | Number | Required. The number of initial splits
- |
Blurs the current editor.
-
Blurs the current editor.
-
Focuses the current editor.
-
Focuses the current editor.
-
Executes callback on all of the available editors.
-
Executes callback on all of the available editors.
-
Arguments
| callback | Function | Required. A callback function to execute
- |
| scope | String | Required.
- |
Returns the current editor.
-
Returns the current editor.
-
Returns the editor identified by the index idx.
-
Returns the editor identified by the index idx.
-
Arguments
| idx | Number | Required. The index of the editor you want
- |
Returns the orientation.
-
Returns the orientation.
-
Returns the number of splits.
-
Returns the number of splits.
-
- Split.setFontSize(Number size)
Sets the font size, in pixels, for all the available editors.
-
Sets the font size, in pixels, for all the available editors.
-
Arguments
| size | Number | Required. The new font size
- |
- Split.setKeyboardHandler(String keybinding)
- Split.setOrientation(Number oriantation)
Sets the orientation.
-
Arguments
Sets a new EditSession for the indicated editor.
-
Arguments
| session | EditSession | Required. The new edit session
- |
| idx | Number | Required. The editor's index you're interested in
- |
- Split.setSplits(Number splits)
Arguments
| splits | Number | Required. The new number of splits
- |
Sets a theme for each of the available editors.
-
Sets a theme for each of the available editors.
-
Arguments
| theme | String | Required. The name of the theme to set
- |
This class provides an essay way to treat the document as a stream of tokens, and provides methods to iterate over these tokens.
-
Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.
-
Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.
-
Arguments
| session | EditSession | Required. The session to associate with
- |
| initialRow | Number | Required. The row to start the tokenizing at
- |
| initialColumn | Number | Required. The column to start the tokenizing at
- |
- TokenIterator.getCurrentToken()
Returns the current tokenized string.
-
Returns the current tokenized string.
-
- TokenIterator.getCurrentTokenColumn()
Returns the current column.
-
Returns the current column.
-
- TokenIterator.getCurrentTokenRow()
Returns the current row.
-
Returns the current row.
-
- TokenIterator.stepBackward()
Tokenizes all the items from the current point to the row prior in the document.
-
Tokenizes all the items from the current point to the row prior in the document.
-
Returns
| String | If the current point is not at the top of the file, this function returns null. Otherwise, it returns an array of the tokenized strings.
- |
- TokenIterator.stepForward()
Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.
-
Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.
-
Constructs a new tokenizer based on the given rules and flags.
-
Constructs a new tokenizer based on the given rules and flags.
-
Arguments
| rules | Object | Required. The highlighting rules
- |
| flag | String | Required. Any additional regular expression flags to pass (like "i" for case insensitive)
- |
- Tokenizer.getLineTokens()
Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.
-
Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.
-
This object maintains the undo stack for an EditSession.
-
Resets the current undo state and creates a new UndoManager.
-
Resets the current undo state and creates a new UndoManager.
-
- UndoManager.execute(Object options)
Provides a means for implementing your own undo manager. options has one property, args, an Array, with two elements:
-
Provides a means for implementing your own undo manager. options has one property, args, an Array, with two elements:
-
-args[0] is an array of deltasargs[1] is the document to associate with
-
Arguments
| options | Object | Required. Contains additional properties
- |
Returns true if there are redo operations left to perform.
-
Returns true if there are redo operations left to perform.
-
Returns true if there are undo operations left to perform.
-
Returns true if there are undo operations left to perform.
-
- UndoManager.redo(Boolean dontSelect)
Perform a redo operation on the document, reimplementing the last change.
-
Perform a redo operation on the document, reimplementing the last change.
-
Arguments
| dontSelect | Boolean | Required. If true, doesn't select the range of where the change occured
- |
Destroys the stack of undo and redo redo operations.
-
Destroys the stack of undo and redo redo operations.
-
- UndoManager.undo(Boolean dontSelect)
Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
-
Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
-
Arguments
| dontSelect | Boolean | Required. If true, doesn't select the range of where the change occured
- |
The class that is responsible for drawing everything you see on the screen!
-
Constructs a new VirtualRenderer within the container specified, applying the given theme.
-
Constructs a new VirtualRenderer within the container specified, applying the given theme.
-
Arguments
| container | DOMElement | Required. The root element of the editor
- |
| theme | String | Required. The starting theme
- |
- VirtualRenderer.addGutterDecoration(row, className)
- VirtualRenderer.adjustWrapLimit()
Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.
-
Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.
-
- VirtualRenderer.destroy()
Destroys the text and cursor layers for this renderer.
-
Destroys the text and cursor layers for this renderer.
-
- VirtualRenderer.getAnimatedScroll()
Returns whether an animated scroll happens or not.
-
- VirtualRenderer.getContainerElement()
Returns the root element containing this renderer.
-
Returns the root element containing this renderer.
-
- VirtualRenderer.getFirstFullyVisibleRow()
Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
-
Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
-
- VirtualRenderer.getFirstVisibleRow()
Returns the index of the first visible row.
-
Returns the index of the first visible row.
-
- VirtualRenderer.getHScrollBarAlwaysVisible()
Returns whether the horizontal scrollbar is set to be always visible.
-
- VirtualRenderer.getLastFullyVisibleRow()
Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
-
Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
-
- VirtualRenderer.getLastVisibleRow()
Returns the index of the last visible row.
-
Returns the index of the last visible row.
-
- VirtualRenderer.getMouseEventTarget()
Returns the element that the mouse events are attached to
-
Returns the element that the mouse events are attached to
-
- VirtualRenderer.getPrintMarginColumn()
Returns whether the print margin column is being shown or not.
-
Returns whether the print margin column is being shown or not.
-
- VirtualRenderer.getScrollBottomRow()
Returns the last visible row, regardless of whether it's fully visible or not.
-
- VirtualRenderer.getScrollLeft()
Returns the value of the distance between the left of the editor and the leftmost part of the visible content.
-
- VirtualRenderer.getScrollTop()
Returns the value of the distance between the top of the editor and the topmost part of the visible content.
-
- VirtualRenderer.getScrollTopRow()
Returns the first visible row, regardless of whether it's fully visible or not.
-
- VirtualRenderer.getShowGutter()
Returns true if the gutter is being shown.
-
Returns true if the gutter is being shown.
-
- VirtualRenderer.getShowInvisibles()
Returns whether invisible characters are being shown or not.
-
Returns whether invisible characters are being shown or not.
-
- VirtualRenderer.getShowPrintMargin()
Returns whetherthe print margin is being shown or not.
-
Returns whetherthe print margin is being shown or not.
-
- VirtualRenderer.getTextAreaContainer()
Returns the element to which the hidden text area is added.
-
Returns the element to which the hidden text area is added.
-
- VirtualRenderer.getTheme()
Returns the path of the current theme.
-
Returns the path of the current theme.
-
- VirtualRenderer.hideComposition()
Hides the current composition.
-
Hides the current composition.
-
- VirtualRenderer.hideCursor()
- VirtualRenderer.isScrollableBy(Number deltaX, Number deltaY)
Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.
-
Arguments
| deltaX | Number | Required. The x value to scroll by
- |
| deltaY | Number | Required. The y value to scroll by
- |
Triggers a resize of the editor.
-
Triggers a resize of the editor.
-
Arguments
| force | Boolean | Required. If true, recomputes the size, even if the height and width haven't changed
- |
| gutterWidth | Number | Required. The width of the gutter in pixels
- |
| width | Number | Required. The width of the editor in pixels
- |
| height | Number | Required. The hiehgt of the editor, in pixels
- |
- VirtualRenderer.removeGutterDecoration(row, className)
Scrolls the editor across both x- and y-axes.
-
Arguments
| deltaX | Number | Required. The x value to scroll by
- |
| deltaY | Number | Required. The y value to scroll by
- |
- VirtualRenderer.scrollCursorIntoView(cursor, offset)
Scrolls the cursor into the first visibile area of the editor
-
Gracefully scrolls the editor to the row indicated.
-
Arguments
| line | Number | Required. A line number
- |
| center | Boolean | Required. If true, centers the editor the to indicated line
- |
| animate | Boolean | Required. If true animates scrolling
- |
| callback | Function | Required. Function to be called after the animation has finished
- |
- VirtualRenderer.scrollToRow(Number row)
Gracefully scrolls the top of the editor to the row indicated.
-
Arguments
- VirtualRenderer.scrollToX(Number scrollLeft)
Scrolls the editor to the x pixel indicated.
-
Arguments
| scrollLeft | Number | Required. The position to scroll to
- |
- VirtualRenderer.scrollToY(Number scrollTop)
Scrolls the editor to the y pixel indicated.
-
Arguments
| scrollTop | Number | Required. The position to scroll to
- |
- VirtualRenderer.setAnimatedScroll(Boolean shouldAnimate)
Identifies whether you want to have an animated scroll or not.
-
Arguments
| shouldAnimate | Boolean | Required. Set to true to show animated scrolls
- |
- VirtualRenderer.setAnnotations(Array annotations)
Sets annotations for the gutter.
-
Sets annotations for the gutter.
-
Arguments
| annotations | Array | Required. An array containing annotations
- |
- VirtualRenderer.setCompositionText(String text)
Sets the inner text of the current composition to text.
-
Sets the inner text of the current composition to text.
-
Arguments
| text | String | Required. A string of text to use
- |
- VirtualRenderer.setHScrollBarAlwaysVisible(Boolean alwaysVisible)
Identifies whether you want to show the horizontal scrollbar or not.
-
Arguments
| alwaysVisible | Boolean | Required. Set to true to make the horizontal scroll bar visible
- |
- VirtualRenderer.setPadding(Number padding)
Sets the padding for all the layers.
-
Sets the padding for all the layers.
-
Arguments
| padding | Number | Required. A new padding value (in pixels)
- |
- VirtualRenderer.setPrintMarginColumn(Boolean showPrintMargin)
Identifies whether you want to show the print margin column or not.
-
Identifies whether you want to show the print margin column or not.
-
Arguments
| showPrintMargin | Boolean | Required. Set to true to show the print margin column
- |
- VirtualRenderer.setSession(session)
- VirtualRenderer.setShowGutter(Boolean show)
Identifies whether you want to show the gutter or not.
-
Identifies whether you want to show the gutter or not.
-
Arguments
| show | Boolean | Required. Set to true to show the gutter
- |
- VirtualRenderer.setShowInvisibles(Boolean showInvisibles)
Identifies whether you want to show invisible characters or not.
-
Identifies whether you want to show invisible characters or not.
-
Arguments
| showInvisibles | Boolean | Required. Set to true to show invisibles
- |
- VirtualRenderer.setShowPrintMargin(Boolean showPrintMargin)
Identifies whether you want to show the print margin or not.
-
Identifies whether you want to show the print margin or not.
-
Arguments
| showPrintMargin | Boolean | Required. Set to true to show the print margin
- |
- VirtualRenderer.setStyle(String style)
Adds a new class, style, to the editor.
-
Adds a new class, style, to the editor.
-
Arguments
| style | String | Required. A class name
- |
- VirtualRenderer.setTheme(String theme)
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
-
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
-
Arguments
| theme | String | Required. The path to a theme
- |
- VirtualRenderer.showComposition(Number position)
- VirtualRenderer.showCursor()
- VirtualRenderer.textToScreenCoordinates(Number row, Number column)
Returns an object containing the pageX and pageY coordinates of the document position.
-
Returns an object containing the pageX and pageY coordinates of the document position.
-
Arguments
| row | Number | Required. The document row position
- |
| column | Number | Required. The document column position
- |
- VirtualRenderer.unsetStyle(String style)
Removes the class style from the editor.
-
Removes the class style from the editor.
-
Arguments
| style | String | Required. A class name
- |
- VirtualRenderer.updateBackMarkers()
Schedules an update to all the back markers in the document.
-
Schedules an update to all the back markers in the document.
-
- VirtualRenderer.updateBreakpoints()
- VirtualRenderer.updateCursor()
Updates the cursor icon.
-
Updates the cursor icon.
-
- VirtualRenderer.updateFontSize()
- VirtualRenderer.updateFrontMarkers()
Schedules an update to all the front markers in the document.
-
Schedules an update to all the front markers in the document.
-
- VirtualRenderer.updateFull(Boolean force)
Triggers a full update of all the layers, for all the rows.
-
Triggers a full update of all the layers, for all the rows.
-
Arguments
| force | Boolean | Required. If true, forces the changes through
- |
- VirtualRenderer.updateLines(Number firstRow, Number lastRow)
Triggers a partial update of the text, from the range given by the two parameters.
-
Triggers a partial update of the text, from the range given by the two parameters.
-
Arguments
| firstRow | Number | Required. The first row to update
- |
| lastRow | Number | Required. The last row to update
- |
- VirtualRenderer.updateText()
Triggers a full update of the text, for all the rows.
-
Triggers a full update of the text, for all the rows.
-
- VirtualRenderer.visualizeBlur()
Blurs the current container.
-
Blurs the current container.
-
- VirtualRenderer.visualizeFocus()
Focuses the current container.
-
Focuses the current container.
-
- * If `newLineMode == unix`, `\n` is returned.
+ * @returns {String} If `newLineMode == windows`, `\r\n` is returned.
+ * If `newLineMode == unix`, `\n` is returned.
* If `newLineMode == auto`, the value of `autoNewLine` is returned.
*
* Returns the newline character that's being used, depending on the value of `newLineMode`.
*
*
- *
**/
this.getNewLineCharacter = function() {
switch (this.$newLineMode) {
@@ -164,8 +156,7 @@ var Document = function(text) {
this.$autoNewLine = "\n";
this.$newLineMode = "auto";
/**
- * Document.setNewLineMode(newLineMode) -> Void
- * - newLineMode(String): [The newline mode to use; can be either `windows`, `unix`, or `auto`]{: #Document.setNewLineMode.param}
+ * @param {String} newLineMode [The newline mode to use; can be either `windows`, `unix`, or `auto`]{: #Document.setNewLineMode.param}
*
* [Sets the new line mode.]{: #Document.setNewLineMode.desc}
**/
@@ -177,8 +168,6 @@ var Document = function(text) {
};
/**
- * Document.getNewLineMode() -> String
- *
* [Returns the type of newlines being used; either `windows`, `unix`, or `auto`]{: #Document.getNewLineMode}
*
**/
@@ -187,8 +176,7 @@ var Document = function(text) {
};
/**
- * Document.isNewLine(text) -> Boolean
- * - text (String): The text to check
+ * @param {String} text The text to check
*
* Returns `true` if `text` is a newline character (either `\r\n`, `\r`, or `\n`).
*
@@ -198,8 +186,7 @@ var Document = function(text) {
};
/**
- * Document.getLine(row) -> String
- * - row (Number): The row index to retrieve
+ * @param {Number} row The row index to retrieve
*
* Returns a verbatim copy of the given line as it is in the document
*
@@ -209,9 +196,8 @@ var Document = function(text) {
};
/**
- * Document.getLines(firstRow, lastRow) -> [String]
- * - firstRow (Number): The first row index to retrieve
- * - lastRow (Number): The final row index to retrieve
+ * @param {Number} firstRow The first row index to retrieve
+ * @param {Number} lastRow The final row index to retrieve
*
* Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`.
*
@@ -221,8 +207,6 @@ var Document = function(text) {
};
/**
- * Document.getAllLines() -> [String]
- *
* Returns all lines in the document as string array. Warning: The caller should not modify this array!
**/
this.getAllLines = function() {
@@ -230,8 +214,6 @@ var Document = function(text) {
};
/**
- * Document.getLength() -> Number
- *
* Returns the number of rows in the document.
**/
this.getLength = function() {
@@ -239,8 +221,7 @@ var Document = function(text) {
};
/**
- * Document.getTextRange(range) -> String
- * - range (Range): The range to work with
+ * @param {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}
**/
@@ -257,11 +238,6 @@ var Document = function(text) {
}
};
- /** internal, hide
- * Document.$clipPosition(position) -> Number
- *
- *
- **/
this.$clipPosition = function(position) {
var length = this.getLength();
if (position.row >= length) {
@@ -272,13 +248,12 @@ var Document = function(text) {
};
/**
- * Document.insert(position, text) -> Number
- * - position (Number): The position to start inserting at
- * - text (String): A chunk of text to insert
- * + (Number): The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
+ * @param {Number} position The position to start inserting at
+ * @param {String} text A chunk of text to insert
+ * @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
+ *
* Inserts a block of `text` and the indicated `position`.
*
- *
**/
this.insert = function(position, text) {
if (!text || text.length === 0)
@@ -304,21 +279,8 @@ var Document = function(text) {
};
/**
- * Document.insertLines(row, lines) -> Object
- * - row (Number): The index of the row to insert at
- * - lines (Array): An array of strings
- * + (Object): Returns an object containing the final row and column, like this:
- * ```{row: endRow, column: 0}```
- * If `lines` is empty, this function returns an object containing the current row, and column, like this:
- * ```{row: row, column: 0}```
- *
- * Inserts the elements in `lines` into the document, starting at the row index given by `row`. This method also triggers the `'change'` event.
- *
- *
- **/
- /**
- * Document@change(e)
- * - e (Object): Contains at least one property called `"action"`. `"action"` indicates the action that triggered the change. Each action also has a set of additional properties.
+ * @event change
+ * @param {Object} e Contains at least one property called `"action"`. `"action"` indicates the action that triggered the change. Each action also has a set of additional properties.
*
* Fires whenever the document changes.
*
@@ -339,6 +301,22 @@ var Document = function(text) {
* * `text`: the text that's being removed
*
**/
+ /**
+ * @param {Number} row The index of the row to insert at
+ * @param {Array} lines An array of strings
+ * @returns Object Contains the final row and column, like this:
+ * ```
+ * {row: endRow, column: 0}
+ * ```
+ * If `lines` is empty, this function returns an object containing the current row, and column, like this:
+ * ```
+ * {row: row, column: 0}
+ * ```
+ *
+ * Inserts the elements in `lines` into the document, starting at the row index given by `row`. This method also triggers the `'change'` event.
+ *
+ *
+ **/
this.insertLines = function(row, lines) {
if (lines.length == 0)
return {row: row, column: 0};
@@ -365,10 +343,11 @@ var Document = function(text) {
};
/**
- * Document.insertNewLine(position) -> Object
- * - position (String): The position to insert at
- * + (Object): Returns an object containing the final row and column, like this:
- * ```{row: endRow, column: 0}```
+ * @param {String} position The position to insert at
+ * @returns {Object} Returns an object containing the final row and column, like this:
+ * ```
+ * {row: endRow, column: 0}
+ * ```
*
* Inserts a new line into the document at the current row's `position`. This method also triggers the `'change'` event.
*
@@ -398,12 +377,13 @@ var Document = function(text) {
};
/**
- * Document.insertInLine(position, text) -> Object | Number
- * - position (Number): The position to insert at
- * - text (String): A chunk of text
- * + (Object): Returns an object containing the final row and column, like this:
- * ```{row: endRow, column: 0}```
- * + (Number): If `text` is empty, this function returns the value of `position`
+ * @param {Number} position The position to insert at
+ * @param {String} text A chunk of text
+ * @returns {Object} Returns an object containing the final row and column, like this:
+ * ```
+ * {row: endRow, column: 0}
+ * ```
+ * @returns {Number} If `text` is empty, this function returns the value of `position`
*
* Inserts `text` into the `position` at the current row. This method also triggers the `'change'` event.
*
@@ -435,9 +415,8 @@ var Document = function(text) {
};
/**
- * Document.remove(range) -> Object
- * - range (Range): A specified Range to remove
- * + (Object): Returns the new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
+ * @param {Range} range A specified Range to remove
+ * @returns {Object} Returns the new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
*
* Removes the `range` from the document.
*
@@ -476,11 +455,10 @@ var Document = function(text) {
};
/**
- * Document.removeInLine(row, startColumn, endColumn) -> Object
- * - row (Number): The row to remove from
- * - startColumn (Number): The column to start removing at
- * - endColumn (Number): The column to stop removing at
- * + (Object): Returns an object containing `startRow` and `startColumn`, indicating the new row and column values.
If `startColumn` is equal to `endColumn`, this function returns nothing.
+ * @param {Number} row The row to remove from
+ * @param {Number} startColumn The column to start removing at
+ * @param {Number} endColumn The column to stop removing at
+ * @returns {Object} Returns an object containing `startRow` and `startColumn`, indicating the new row and column values.
If `startColumn` is equal to `endColumn`, this function returns nothing.
*
* Removes the specified columns from the `row`. This method also triggers the `'change'` event.
*
@@ -506,10 +484,9 @@ var Document = function(text) {
};
/**
- * Document.removeLines(firstRow, lastRow) -> [String]
- * - firstRow (Number): The first row to be removed
- * - lastRow (Number): The last row to be removed
- * + ([String]): Returns all the removed lines.
+ * @param {Number} firstRow The first row to be removed
+ * @param {Number} lastRow The last row to be removed
+ * @returns {[String]} Returns all the removed lines.
*
* Removes a range of full lines. This method also triggers the `'change'` event.
*
@@ -530,8 +507,7 @@ var Document = function(text) {
};
/**
- * Document.removeNewLine(row) -> Void
- * - row (Number): The row to check
+ * @param {Number} row The row to check
*
* Removes the new line between `row` and the row immediately following it. This method also triggers the `'change'` event.
*
@@ -554,10 +530,9 @@ var Document = function(text) {
};
/**
- * Document.replace(range, text) -> Object
- * - range (Range): A specified Range to replace
- * - text (String): The new text to use as a replacement
- * + (Object): Returns an object containing the final row and column, like this:
+ * @param {Range} range A specified Range to replace
+ * @param {String} text The new text to use as a replacement
+ * @returns {Object} Returns an object containing the final row and column, like this:
* {row: endRow, column: 0}
* If the text and range are empty, this function returns an object containing the current `range.start` value.
* If the text is the exact same as what currently exists, this function returns an object containing the current `range.end` value.
@@ -586,9 +561,7 @@ var Document = function(text) {
};
/**
- * Document.applyDeltas(deltas) -> Void
- *
- * Applies all the changes previously accumulated. These can be either `'includeText'`, `'insertLines'`, `'removeText'`, and `'removeLines'`.
+ * =Applies all the changes previously accumulated. These can be either `'includeText'`, `'insertLines'`, `'removeText'`, and `'removeLines'`.
**/
this.applyDeltas = function(deltas) {
for (var i=0; i Void
- *
* Reverts any changes previously applied. These can be either `'includeText'`, `'insertLines'`, `'removeText'`, and `'removeLines'`.
**/
this.revertDeltas = function(deltas) {
diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js
index dffcd73d..dd74e31d 100644
--- a/lib/ace/edit_session.js
+++ b/lib/ace/edit_session.js
@@ -44,95 +44,97 @@ var BackgroundTokenizer = require("./background_tokenizer").BackgroundTokenizer;
var SearchHighlight = require("./search_highlight").SearchHighlight;
/**
- * class EditSession
+ * @class EditSession
*
- * Stores all the data about [[Editor `Editor`]] state providing easy way to change editors state. `EditSession` can be attached to only one [[Document `Document`]]. Same `Document` can be attached to several `EditSession`s.
+ * Stores all the data about [[Editor `Editor`]] state providing easy way to change editors state.
+ *
+ * `EditSession` can be attached to only one [[Document `Document`]]. Same `Document` can be attached to several `EditSession`s.
*
**/
// events
/**
- * EditSession@change(e)
- * - e (Object): An object containing a `delta` of information about the change.
+ * @event change
+ * @param {Object} e An object containing a `delta` of information about the change.
*
* Emitted when the document changes.
**/
/**
- * EditSession@changeTabSize()
+ * @event changeTabSize
*
* Emitted when the tab size changes, via [[EditSession.setTabSize]].
**/
/**
- * EditSession@changeOverwrite()
+ * @event changeOverwrite
*
* Emitted when the ability to overwrite text changes, via [[EditSession.setOverwrite]].
**/
/**
- * EditSession@changeBreakpoint()
+ * @event changeBreakpoint
*
* Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.
**/
/**
- * EditSession@changeFrontMarker()
+ * @event changeFrontMarker
*
* Emitted when a front marker changes.
**/
/**
- * EditSession@changeBackMarker()
+ * @event changeBackMarker
*
* Emitted when a back marker changes.
**/
/**
- * EditSession@changeAnnotation()
+ * @event changeAnnotation
*
* Emitted when an annotation changes, like through [[EditSession.setAnnotations]].
**/
/**
- * EditSession@tokenizerUpdate(e)
- * - e (Object): An object containing one property, `"data"`, that contains information about the changing rows
+ * @event tokenizerUpdate
+ * @param {Object} e An object containing one property, `"data"`, that contains information about the changing rows
*
* Emitted when a background tokenizer asynchronously processes new rows.
*
**/
-/** hide
- * EditSession@loadMode(e)
- *
+/**
+ * @event loadMode
+ * @param e
*
*
**/
/**
- * EditSession@changeMode()
+ * @event changeMode
*
* Emitted when the current mode changes.
*
**/
/**
- * EditSession@changeWrapMode()
+ * @event changeWrapMode
*
* Emitted when the wrap mode changes.
*
**/
/**
- * EditSession@changeWrapLimit()
+ * @event changeWrapLimit
*
* Emitted when the wrapping limit changes.
*
**/
/**
- * EditSession@changeFold(e)
+ * @event changeFold
*
* Emitted when a code fold is added or removed.
*
**/
/**
- * EditSession@changeScrollTop(scrollTop)
- * - scrollTop (Number): The new scroll top value
+ * @event changeScrollTop
+ * @param {Number} scrollTop The new scroll top value
*
* Emitted when the scroll top changes.
**/
/**
- * EditSession@changeScrollLeft(scrollLeft)
- * - scrollLeft (Number): The new scroll left value
+ * @event changeScrollLeft
+ * @param {Number} scrollLeft The new scroll left value
*
* Emitted when the scroll left changes.
**/
@@ -140,8 +142,8 @@ var SearchHighlight = require("./search_highlight").SearchHighlight;
/**
* new EditSession(text, mode)
- * - text (Document | String): If `text` is a `Document`, it associates the `EditSession` with it. Otherwise, a new `Document` is created, with the initial text
- * - mode (TextMode): The inital language mode to use for the document
+ * @param {Document | String} text If `text` is a `Document`, it associates the `EditSession` with it. Otherwise, a new `Document` is created, with the initial text
+ * @param {TextMode} mode The inital language mode to use for the document
*
* Sets up a new `EditSession` and associates it with the given `Document` and `TextMode`.
*
@@ -165,11 +167,11 @@ var EditSession = function(text, mode) {
}
this.on("changeFold", this.onChangeFold.bind(this));
this.$onChange = this.onChange.bind(this);
-
+
if (typeof text != "object" || !text.getLine)
text = new Document(text);
- this.setDocument(text);
+ this.setDocument(text);
this.selection = new Selection(this);
this.setMode(mode);
@@ -181,8 +183,7 @@ var EditSession = function(text, mode) {
oop.implement(this, EventEmitter);
/**
- * EditSession.setDocument(doc)
- * - doc (Document): The new `Document` to use
+ * @param {Document} doc The new `Document` to use
*
* Sets the `EditSession` to point to a new `Document`. If a `BackgroundTokenizer` exists, it also points to `doc`.
*
@@ -210,9 +211,8 @@ var EditSession = function(text, mode) {
return this.doc;
};
- /** internal, hide
- * EditSession.$resetRowCache(row)
- * - row (Number): The row to work with
+ /**
+ * @param {Number} row The row to work with
*
*
*
@@ -288,8 +288,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.setValue(text)
- * - text (String): The new text to place
+ * @param {String} text The new text to place
*
* Sets the session text.
*
@@ -306,16 +305,15 @@ var EditSession = function(text, mode) {
this.getUndoManager().reset();
};
- /** alias of: EditSession.toString
- * EditSession.getValue() -> String
- *
+ /**
* Returns the current [[Document `Document`]] as a string.
- *
+ * @method toString
+ * @alias EditSession.toString
+ *
**/
- /** alias of: EditSession.getValue
- * EditSession.toString() -> String
- *
- * Returns the current [[Document `Document`]] as a string.
+
+ /**
+ * Returns the current [[Document `Document`]] as a string.
*
**/
this.getValue =
@@ -324,28 +322,26 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getSelection() -> Selection
- *
* Returns the string of the current selection.
**/
this.getSelection = function() {
return this.selection;
};
- /** related to: BackgroundTokenizer.getState
- * EditSession.getState(row) -> Array
- * - row (Number): The row to start at
+ /**
+ * @param {Number} row The row to start at
*
* {:BackgroundTokenizer.getState}
*
+ * @related BackgroundTokenizer.getState
**/
this.getState = function(row) {
return this.bgTokenizer.getState(row);
};
- /** related to: BackgroundTokenizer.getTokens
- * EditSession.getTokens(row) -> Array
- * - row (Number): The row to start at
+ /**
+ *
+ * @param {Number} row The row to start at
*
* Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.
*
@@ -355,9 +351,8 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getTokenAt(row, column) -> Object
- * - row (Number): The row number to retrieve from
- * - column (Number): The column number to retrieve from
+ * @param {Number} row The row number to retrieve from
+ * @param {Number} column The column number to retrieve from
*
* Returns an object indicating the token at the current row. The object has two properties: `index` and `start`.
**/
@@ -381,10 +376,9 @@ var EditSession = function(text, mode) {
token.start = c - token.value.length;
return token;
};
-
+
/**
- * EditSession.setUndoManager(undoManager)
- * - undoManager (UndoManager): The new undo manager
+ * @param {UndoManager} undoManager The new undo manager
*
* Sets the undo manager.
**/
@@ -399,11 +393,7 @@ var EditSession = function(text, mode) {
if (undoManager) {
var self = this;
- /** internal, hide
- * EditSession.$syncInformUndoManager()
- *
- *
- **/
+
this.$syncInformUndoManager = function() {
self.$informUndoManager.cancel();
@@ -444,17 +434,13 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getUndoManager() -> UndoManager
- *
* Returns the current undo manager.
**/
this.getUndoManager = function() {
return this.$undoManager || this.$defaultUndoManager;
- },
+ };
/**
- * EditSession.getTabString() -> String
- *
* Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by [[EditSession.getTabSize `getTabSize()`]]); otherwise it's simply `'\t'`.
**/
this.getTabString = function() {
@@ -467,8 +453,7 @@ var EditSession = function(text, mode) {
this.$useSoftTabs = true;
/**
- * EditSession.setUseSoftTabs(useSoftTabs)
- * - useSoftTabs (Boolean): Value indicating whether or not to use soft tabs
+ * @param {Boolean} useSoftTabs 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'`).
*
@@ -480,8 +465,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getUseSoftTabs() -> Boolean
- *
* Returns `true` if soft tabs are being used, `false` otherwise.
*
**/
@@ -491,8 +474,7 @@ var EditSession = function(text, mode) {
this.$tabSize = 4;
/**
- * EditSession.setTabSize(tabSize)
- * - tabSize (Number): The new tab size
+ * @param {Number} tabSize 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.
**/
@@ -506,8 +488,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getTabSize() -> Number
- *
* Returns the current tab size.
**/
this.getTabSize = function() {
@@ -515,8 +495,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.isTabStop(position) -> Boolean
- * - position (Object): The position to check
+ * @param {Object} position The position to check
*
* Returns `true` if the character at the position is a soft tab.
**/
@@ -526,8 +505,7 @@ var EditSession = function(text, mode) {
this.$overwrite = false;
/**
- * EditSession.setOverwrite(overwrite)
- * - overwrite (Boolean): Defines wheter or not to set overwrites
+ * @param {Boolean} overwrite Defines wheter or not to set overwrites
*
* Pass in `true` to enable overwrites in your session, or `false` to disable.
*
@@ -542,8 +520,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getOverwrite() -> Boolean
- *
* Returns `true` if overwrites are enabled; `false` otherwise.
**/
this.getOverwrite = function() {
@@ -551,8 +527,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.toggleOverwrite()
- *
* Sets the value of overwrite to the opposite of whatever it currently is.
**/
this.toggleOverwrite = function() {
@@ -560,9 +534,8 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.addGutterDecoration(row, className) -> Void
- * - row (Number): The row number
- * - className (String): The class to add
+ * @param {Number} row The row number
+ * @param {String} className The class to add
*
* Adds `className` to the `row`, to be used for CSS stylings and whatnot.
**/
@@ -574,9 +547,8 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.removeGutterDecoration(row, className)-> Void
- * - row (Number): The row number
- * - className (String): The class to add
+ * @param {Number} row The row number
+ * @param {String} className The class to add
*
* Removes `className` from the `row`.
**/
@@ -586,17 +558,15 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getBreakpoints() -> Array
- *
* Returns an array of numbers, indicating which rows have breakpoints.
+ * @returns [Number]
**/
this.getBreakpoints = function() {
return this.$breakpoints;
};
/**
- * EditSession.setBreakpoints(rows)
- * - rows (Array): An array of row indicies
+ * @param {Array} rows An array of row indicies
*
* Sets a breakpoint on every row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
*
@@ -610,8 +580,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.clearBreakpoints()
- *
* Removes all breakpoints on the rows. This function also emites the `'changeBreakpoint'` event.
**/
this.clearBreakpoints = function() {
@@ -620,9 +588,8 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.setBreakpoint(row, className)
- * - row (Number): A row index
- * - className (String): Class of the breakpoint
+ * @param {Number} row A row index
+ * @param {String} className Class of the breakpoint
*
* Sets a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
**/
@@ -637,8 +604,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.clearBreakpoint(row)
- * - row (Number): A row index
+ * @param {Number} row A row index
*
* Removes a breakpoint on the row number given by `rows`. This function also emites the `'changeBreakpoint'` event.
**/
@@ -648,14 +614,13 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.addMarker(range, clazz, type = "line", inFront) -> Number
- * - range (Range): Define the range of the marker
- * - clazz (String): Set the CSS class for the marker
- * - type (Function | String): Identify the type of the marker
- * - inFront (Boolean): Set to `true` to establish a front marker
+ * @param {Range} range Define the range of the marker
+ * @param {String} clazz Set the CSS class for the marker
+ * @param {Function | String} type Identify the type of the marker
+ * @param {Boolean} inFront Set to `true` to establish a front marker
*
* Adds a new marker to the given `Range`. If `inFront` is `true`, a front marker is defined, and the `'changeFrontMarker'` event fires; otherwise, the `'changeBackMarker'` event fires.
- *
+ * @return Number
**/
this.addMarker = function(range, clazz, type, inFront) {
var id = this.$markerId++;
@@ -681,11 +646,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.addDynamicMarker(marker, inFront) -> Object
- * - marker (Object): object with update method
- * - inFront (Boolean): Set to `true` to establish a front marker
+ * @param {Object} marker object with update method
+ * @param {Boolean} inFront Set to `true` to establish a front marker
*
* Adds a dynamic marker to the session.
+ * @return Object The added marker
**/
this.addDynamicMarker = function(marker, inFront) {
if (!marker.update)
@@ -706,8 +671,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.removeMarker(markerId)
- * - markerId (Number): A number representing a marker
+ * @param {Number} markerId 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.
*
@@ -725,11 +689,10 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getMarkers(inFront) -> Array
- * - inFront (Boolean): If `true`, indicates you only want front markers; `false` indicates only back markers
+ * @param {Boolean} inFront If `true`, indicates you only want front markers; `false` indicates only back markers
*
* Returns an array containing the IDs of all the markers, either front or back.
- *
+ * @returns Array
**/
this.getMarkers = function(inFront) {
return inFront ? this.$frontMarkers : this.$backMarkers;
@@ -769,8 +732,7 @@ var EditSession = function(text, mode) {
* }
*/
/**
- * EditSession.setAnnotations(annotations)
- * - annotations (Array): A list of annotations
+ * @param {Array} annotations A list of annotations
*
* Sets annotations for the `EditSession`. This functions emits the `'changeAnnotation'` event.
**/
@@ -780,17 +742,14 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getAnnotations() -> Object
- *
* Returns the annotations for the `EditSession`.
+ * @returns Object
**/
this.getAnnotations = function() {
return this.$annotations || [];
};
/**
- * EditSession.clearAnnotations()
- *
* Clears all the annotations for this session. This function also triggers the `'changeAnnotation'` event.
**/
this.clearAnnotations = function() {
@@ -798,9 +757,9 @@ var EditSession = function(text, mode) {
this._emit("changeAnnotation", {});
};
- /** internal, hide
+ /**
* EditSession.$detectNewLine(text)
- * - text (String): A block of text
+ * @param {String} text A block of text
*
* If `text` contains either the newline (`\n`) or carriage-return ('\r') characters, `$autoNewLine` stores that value.
*
@@ -815,12 +774,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getWordRange(row, column) -> Range
- * - row (Number): The row to start at
- * - column (Number): The column to start at
+ * @param {Number} row The row to start at
+ * @param {Number} column The column to start at
*
* Given a starting row and column, this method returns the `Range` of the first word boundary it finds.
- *
+ * @returns Range
**/
this.getWordRange = function(row, column) {
var line = this.getLine(row);
@@ -857,11 +815,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getAWordRange(row, column) -> Range
- * - row (Number): The row number to start from
- * - column (Number): The column number to start from
+ * @param {Number} row The row number to start from
+ * @param {Number} column The column number to start from
*
* Gets the range of a word, including its right whitespace.
+ * @return Range
**/
this.getAWordRange = function(row, column) {
var wordRange = this.getWordRange(row, column);
@@ -873,20 +831,20 @@ var EditSession = function(text, mode) {
return wordRange;
};
- /** related to: Document.setNewLineMode
- * EditSession.setNewLineMode(newLineMode)
- * - newLineMode (String): {:Document.setNewLineMode.param}
+ /**
+ * @param {String} newLineMode {:Document.setNewLineMode.param}
*
* {:Document.setNewLineMode.desc}
+ * @related Document.setNewLineMode
**/
this.setNewLineMode = function(newLineMode) {
this.doc.setNewLineMode(newLineMode);
};
- /** related to: Document.getNewLineMode
- * EditSession.getNewLineMode() -> String
- *
+ /**
+ *
* Returns the current new line mode.
+ * @related Document.getNewLineMode
**/
this.getNewLineMode = function() {
return this.doc.getNewLineMode();
@@ -895,8 +853,7 @@ var EditSession = function(text, mode) {
this.$useWorker = true;
/**
- * EditSession.setUseWorker(useWorker)
- * - useWorker (Boolean): Set to `true` to use a worker
+ * @param {Boolean} useWorker Set to `true` to use a worker
*
* Identifies if you want to use a worker for the `EditSession`.
*
@@ -913,8 +870,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getUseWorker() -> Boolean
- *
* Returns `true` if workers are being used.
**/
this.getUseWorker = function() {
@@ -922,8 +877,6 @@ var EditSession = function(text, mode) {
};
/**
- * 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.
**/
this.onReloadTokenizer = function(e) {
@@ -998,8 +951,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.setMode(mode)
- * - mode (TextMode): Set a new text mode
+ * @param {TextMode} mode 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.
*
@@ -1061,11 +1013,7 @@ var EditSession = function(text, mode) {
this._emit("changeMode");
};
- /** internal, hide
- * EditSession.stopWorker()
- *
- *
- **/
+
this.$stopWorker = function() {
if (this.$worker)
this.$worker.terminate();
@@ -1073,11 +1021,7 @@ var EditSession = function(text, mode) {
this.$worker = null;
};
- /** internal, hide
- * EditSession.$startWorker()
- *
- *
- **/
+
this.$startWorker = function() {
if (typeof Worker !== "undefined" && !require.noWorker) {
try {
@@ -1093,9 +1037,8 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getMode() -> TextMode
- *
* Returns the current text mode.
+ * @returns Mode The current text mode
**/
this.getMode = function() {
return this.$mode;
@@ -1103,8 +1046,7 @@ var EditSession = function(text, mode) {
this.$scrollTop = 0;
/**
- * EditSession.setScrollTop(scrollTop)
- * - scrollTop (Number): The new scroll top value
+ * @param {Number} scrollTop The new scroll top value
*
* This function sets the scroll top value. It also emits the `'changeScrollTop'` event.
**/
@@ -1118,9 +1060,8 @@ 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 Number
**/
this.getScrollTop = function() {
return this.$scrollTop;
@@ -1128,8 +1069,6 @@ var EditSession = function(text, mode) {
this.$scrollLeft = 0;
/**
- * 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}
**/
this.setScrollLeft = function(scrollLeft) {
@@ -1142,18 +1081,16 @@ 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 Number
**/
this.getScrollLeft = function() {
return this.$scrollLeft;
};
/**
- * EditSession.getScreenWidth() -> Number
- *
* Returns the width of the screen.
+ * @returns Number
**/
this.getScreenWidth = function() {
this.$computeWidth();
@@ -1194,53 +1131,51 @@ var EditSession = function(text, mode) {
}
};
- /** related to: Document.getLine
- * EditSession.getLine(row) -> String
- * - row (Number): The row to retrieve from
+ /**
+ * @param {Number} row The row to retrieve from
*
* Returns a verbatim copy of the given line as it is in the document
+ * @returns String
*
**/
this.getLine = function(row) {
return this.doc.getLine(row);
};
- /** related to: Document.getLines
- * EditSession.getLines(firstRow, lastRow) -> Array
- * - firstRow (Number): The first row index to retrieve
- * - lastRow (Number): The final row index to retrieve
+ /**
+ * @param {Number} firstRow The first row index to retrieve
+ * @param {Number} lastRow The final row index to retrieve
*
* Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`.
+ * @returns [String]
*
**/
this.getLines = function(firstRow, lastRow) {
return this.doc.getLines(firstRow, lastRow);
};
- /** related to: Document.getLength
- * EditSession.getLength()-> Number
- *
- * Returns the number of rows in the document.
+ /**
+ * Returns the number of rows in the document.
+ * @returns Number
**/
this.getLength = function() {
return this.doc.getLength();
};
- /** related to: Document.getTextRange
- * EditSession.getTextRange(range) -> String
- * - range (Range): The range to work with
+ /**
+ * @param {Range} range The range to work with
*
* {:Document.getTextRange.desc}
+ * @returns Range
**/
this.getTextRange = function(range) {
return this.doc.getTextRange(range || this.selection.getRange());
};
- /** related to: Document.insert
- * EditSession.insert(position, text) -> Number
- * - position (Number): The position to start inserting at
- * - text (String): A chunk of text to insert
- * + (Number): The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
+ /**
+ * @param {Number} position The position to start inserting at
+ * @param {String} text A chunk of text to insert
+ * @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
*
* Inserts a block of `text` and the indicated `position`.
*
@@ -1250,12 +1185,12 @@ var EditSession = function(text, mode) {
return this.doc.insert(position, text);
};
- /** related to: Document.remove
- * EditSession.remove(range) -> Object
- * - range (Range): A specified Range to remove
- * + (Object): The new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
+ /**
+ * @param {Range} range A specified Range to remove
+ * @returns {Object} The new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
*
* Removes the `range` from the document.
+ * @related Document.remove
*
*
**/
@@ -1264,11 +1199,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.undoChanges(deltas, dontSelect) -> Range
- * - deltas (Array): An array of previous changes
- * - dontSelect (Boolean): [If `true`, doesn't select the range of where the change occured]{: #dontSelect}
+ * @param {Array} deltas An array of previous changes
+ * @param {Boolean} dontSelect [If `true`, doesn't select the range of where the change occured]{: #dontSelect}
*
* Reverts previous changes to your document.
+ * @returns Range
**/
this.undoChanges = function(deltas, dontSelect) {
if (!deltas.length)
@@ -1297,11 +1232,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.redoChanges(deltas, dontSelect) -> Range
- * - deltas (Array): An array of previous changes
- * - dontSelect (Boolean): {:dontSelect}
+ * @param {Array} deltas An array of previous changes
+ * @param {Boolean} dontSelect {:dontSelect}
*
* Re-implements a previously undone change to your document.
+ * @returns Range
**/
this.redoChanges = function(deltas, dontSelect) {
if (!deltas.length)
@@ -1326,20 +1261,14 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.setUndoSelect(enable)
- * - enable (Boolean): If `true`, selects the range of the reinserted change
+ * @param {Boolean} enable 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.
**/
this.setUndoSelect = function(enable) {
this.$undoSelect = enable;
};
- /** internal, hide
- * EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange) -> Range
- *
- *
- **/
this.$getUndoSelection = function(deltas, isUndo, lastUndoRange) {
function isInsert(delta) {
var insert =
@@ -1392,19 +1321,22 @@ var EditSession = function(text, mode) {
}
return range;
- },
+ };
- /** related to: Document.replace
+ /** related to:
* EditSession.replace(range, text) -> Object
- * - range (Range): A specified Range to replace
- * - text (String): The new text to use as a replacement
- * + (Object): Returns an object containing the final row and column, like this:
- * ```{row: endRow, column: 0}```
- * If the text and range are empty, this function returns an object containing the current `range.start` value.
+ * @param {Range} range A specified Range to replace
+ * @param {String} text The new text to use as a replacement
+ * @returns Object An object containing the final row and column, like this:
+ * ```
+ * {row: endRow, column: 0}
+ * ```
+ * If the text and range are empty, this function returns an object containing the current `range.start` value.
* If the text is the exact same as what currently exists, this function returns an object containing the current `range.end` value.
*
* Replaces a range in the document with the new `text`.
- *
+ *
+ * @related Document.replace
*
*
**/
@@ -1413,10 +1345,9 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.moveText(fromRange, toPosition) -> Range
- * - fromRange (Range): The range of text you want moved within the document
- * - toPosition (Object): The location (row and column) where you want to move the text to
- * + (Range): The new range where the text was moved to.
+ * @param {Range} fromRange The range of text you want moved within the document
+ * @param {Object} toPosition The location (row and column) where you want to move the text to
+ * @returns {Range} The new range where the text was moved to.
* Moves a range of text from the given range to the given position. `toPosition` is an object that looks like this:
*
* { row: newRowLocation, column: newColumnLocation }
@@ -1455,10 +1386,9 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.indentRows(startRow, endRow, indentString)
- * - startRow (Number): Starting row
- * - endRow (Number): Ending row
- * - indentString (String): The indent token
+ * @param {Number} startRow Starting row
+ * @param {Number} endRow Ending row
+ * @param {String} indentString The indent token
*
* Indents all the rows, from `startRow` to `endRow` (inclusive), by prefixing each row with the token in `indentString`.
*
@@ -1472,8 +1402,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.outdentRows(range)
- * - range (Range): A range of rows
+ * @param {Range} range A range of rows
*
* Outdents all the rows defined by the `start` and `end` properties of `range`.
*
@@ -1502,14 +1431,13 @@ var EditSession = function(text, mode) {
}
};
- /** related to: Document.insertLines
- * EditSession.moveLinesUp(firstRow, lastRow) -> Number
- * - firstRow (Number): The starting row to move up
- * - lastRow (Number): The final row to move up
- * + (Number): If `firstRow` is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.
+ /**
+ * @param {Number} firstRow The starting row to move up
+ * @param {Number} lastRow The final row to move up
+ * @returns {Number} If `firstRow` is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.
*
* Shifts all the lines in the document up one, starting from `firstRow` and ending at `lastRow`.
- *
+ * @related Document.insertLines
*
**/
this.moveLinesUp = function(firstRow, lastRow) {
@@ -1520,14 +1448,14 @@ var EditSession = function(text, mode) {
return -1;
};
- /** related to: Document.insertLines
- * EditSession.moveLinesDown(firstRow, lastRow) -> Number
- * - firstRow (Number): The starting row to move down
- * - lastRow (Number): The final row to move down
- * + (Number): If `firstRow` is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.
- *
+ /**
+ * @param {Number} firstRow The starting row to move down
+ * @param {Number} lastRow The final row to move down
+ * @returns {Number} If `firstRow` is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.
*
+ * Shifts all the lines in the document down one, starting from `firstRow` and ending at `lastRow`.
*
+ * @related Document.insertLines
**/
this.moveLinesDown = function(firstRow, lastRow) {
if (lastRow >= this.doc.getLength()-1) return 0;
@@ -1538,10 +1466,9 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.duplicateLines(firstRow, lastRow) -> Number
- * - firstRow (Number): The starting row to duplicate
- * - lastRow (Number): The final row to duplicate
- * + (Number): Returns the number of new rows added; in other words, `lastRow - firstRow + 1`.
+ * @param {Number} firstRow The starting row to duplicate
+ * @param {Number} lastRow The final row to duplicate
+ * @returns {Number} Returns the number of new rows added; in other words, `lastRow - firstRow + 1`.
*
* Duplicates all the text between `firstRow` and `lastRow`.
*
@@ -1626,8 +1553,7 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.setUseWrapMode(useWrapMode)
- * - useWrapMode (Boolean): Enable (or disable) wrap mode
+ * @param {Boolean} useWrapMode 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.
**/
@@ -1665,9 +1591,8 @@ var EditSession = function(text, mode) {
// in that direction. Or set both parameters to the same number to pin
// the limit to that value.
/**
- * EditSession.setWrapLimitRange(min, max)
- * - min (Number): The minimum wrap value (the left side wrap)
- * - max (Number): The maximum wrap value (the right side wrap)
+ * @param {Number} min The minimum wrap value (the left side wrap)
+ * @param {Number} max The maximum wrap value (the right side wrap)
*
* Sets the boundaries of wrap. Either value can be `null` to have an unconstrained wrap, or, they can be the same number to pin the limit. If the wrap limits for `min` or `max` are different, this method also emits the `'changeWrapMode'` event.
**/
@@ -1681,11 +1606,12 @@ var EditSession = function(text, mode) {
}
};
- /** internal, hide
- * EditSession.adjustWrapLimit(desiredLimit) -> Boolean
- * - desiredLimit (Number): The new wrap limit
- *
+ /**
+ * @param {Number} desiredLimit The new wrap limit
+ * @returns {Boolean}
+ *
* This should generally only be called by the renderer when a resize is detected.
+ * @private
**/
this.adjustWrapLimit = function(desiredLimit) {
var wrapLimit = this.$constrainWrapLimit(desiredLimit);
@@ -1702,11 +1628,6 @@ var EditSession = function(text, mode) {
return false;
};
- /** internal, hide
- * EditSession.$constrainWrapLimit(wrapLimit)
- *
- *
- **/
this.$constrainWrapLimit = function(wrapLimit) {
var min = this.$wrapLimitRange.min;
if (min)
@@ -1721,8 +1642,6 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getWrapLimit() -> Number
- *
* Returns the value of wrap limit.
**/
this.getWrapLimit = function() {
@@ -1730,12 +1649,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getWrapLimitRange() -> Object
- *
* Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this:
*
* { min: wrapLimitRange_min, max: wrapLimitRange_max }
*
+ * @returns Object
**/
this.getWrapLimitRange = function() {
// Avoid unexpected mutation by returning a copy
@@ -1745,11 +1663,6 @@ var EditSession = function(text, mode) {
};
};
- /** internal, hide
- * EditSession.$updateInternalDataOnChange()
- *
- *
- **/
this.$updateInternalDataOnChange = function(e) {
var useWrapMode = this.$useWrapMode;
var len;
@@ -1877,10 +1790,6 @@ var EditSession = function(text, mode) {
this.$rowLengthCache[lastRow] = null;
};
- /** internal, hide
- * EditSession.$updateWrapData(firstRow, lastRow)
- *
- **/
this.$updateWrapData = function(firstRow, lastRow) {
var lines = this.doc.getAllLines();
var tabSize = this.getTabSize();
@@ -1939,11 +1848,7 @@ var EditSession = function(text, mode) {
TAB = 11,
TAB_SPACE = 12;
- /** internal, hide
- * EditSession.$computeWrapSplits(tokens, wrapLimit) -> Array
- *
- *
- **/
+
this.$computeWrapSplits = function(tokens, wrapLimit) {
if (tokens.length == 0) {
return [];
@@ -2060,10 +1965,9 @@ var EditSession = function(text, mode) {
return splits;
};
- /** internal, hide
- * EditSession.$getDisplayTokens(str, offset) -> Array
- * - str (String): The string to check
- * - offset (Number): The value to start at
+ /**
+ * @param {String} str The string to check
+ * @param {Number} offset The value to start at
*
* Given a string, returns an array of the display characters, including tabs and spaces.
**/
@@ -2098,12 +2002,11 @@ var EditSession = function(text, mode) {
return arr;
};
- /** internal, hide
- * EditSession.$getStringScreenWidth(str, maxScreenColumn, screenColumn) -> [Number]
- * - str (String): The string to calculate the screen width of
+ /**
+ * @param {String} str The string to calculate the screen width of
* - maxScreenColumn (Number):
* - screenColumn (Number):
- * + ([Number]): Returns an `int[]` array with two elements:
+ * @returns {[Number]} Returns an `int[]` array with two elements:
* The first position indicates the number of columns for `str` on screen.
* The second value contains the position of the document column that this function read until.
*
@@ -2140,11 +2043,11 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getRowLength(row) -> Number
- * - row (Number): The row number to check
+ * @param {Number} row The row number to check
*
*
* Returns number of screenrows in a wrapped line.
+ * @returns Number
**/
this.getRowLength = function(row) {
if (!this.$useWrapMode || !this.$wrapData[row]) {
@@ -2154,21 +2057,20 @@ var EditSession = function(text, mode) {
}
};
- /** internal, hide, related to: EditSession.documentToScreenColumn
- * EditSession.getScreenLastRowColumn(screenRow) -> Number
- * - screenRow (Number): The screen row to check
+ /**
+ * @param {Number} screenRow The screen row to check
*
* Returns the column position (on screen) for the last character in the provided row.
+ * @related EditSession.documentToScreenColumn
**/
this.getScreenLastRowColumn = function(screenRow) {
var pos = this.screenToDocumentPosition(screenRow, Number.MAX_VALUE);
return this.documentToScreenColumn(pos.row, pos.column);
};
- /** internal, hide
- * EditSession.getDocumentLastRowColumn(docRow, docColumn) -> Number
- * - docRow (Number):
- * - docColumn (Number):
+ /**
+ * @param docRow {Number}
+ * @param docColumn {Number}
*
**/
this.getDocumentLastRowColumn = function(docRow, docColumn) {
@@ -2176,8 +2078,9 @@ var EditSession = function(text, mode) {
return this.getScreenLastRowColumn(screenRow);
};
- /** internal, hide
- * EditSession.getDocumentLastRowColumnPosition(docRow, docColumn) -> Number
+ /**
+ * @param docRow {Number}
+ * @param docColumn {Number}
*
**/
this.getDocumentLastRowColumnPosition = function(docRow, docColumn) {
@@ -2185,7 +2088,7 @@ var EditSession = function(text, mode) {
return this.screenToDocumentPosition(screenRow, Number.MAX_VALUE / 10);
};
- /** internal, hide
+ /**
* EditSession.getRowSplitData(row) -> undefined | String
*
**/
@@ -2198,41 +2101,32 @@ var EditSession = function(text, mode) {
};
/**
- * EditSession.getScreenTabSize(screenColumn) -> Number
- * - screenColumn (Number): The screen column to check
+ * @param {Number} screenColumn The screen column to check
*
* The distance to the next tab stop at the specified screen column.
+ * @returns Number
**/
this.getScreenTabSize = function(screenColumn) {
return this.$tabSize - screenColumn % this.$tabSize;
};
- /** internal, hide
- * EditSession.screenToDocumentRow(screenRow, screenColumn) -> Number
- *
- *
- **/
+
this.screenToDocumentRow = function(screenRow, screenColumn) {
return this.screenToDocumentPosition(screenRow, screenColumn).row;
};
- /** internal, hide
- * EditSession.screenToDocumentColumn(screenRow, screenColumn) -> Number
- *
- *
- **/
+
this.screenToDocumentColumn = function(screenRow, screenColumn) {
return this.screenToDocumentPosition(screenRow, screenColumn).column;
};
- /** related to: EditSession.documentToScreenPosition
- * EditSession.screenToDocumentPosition(screenRow, screenColumn) -> Object
- * - screenRow (Number): The screen row to check
- * - screenColumn (Number): The screen column to check
- * + (Object): The object returned has two properties: `row` and `column`.
+ /**
+ * @param {Number} screenRow The screen row to check
+ * @param {Number} screenColumn The screen column to check
+ * @returns {Object} The object returned has two properties: `row` and `column`.
*
* Converts characters coordinates on the screen to characters coordinates within the document. [This takes into account code folding, word wrap, tab size, and any other visual modifications.]{: #conversionConsiderations}
- *
+ * @related EditSession.documentToScreenPosition
*
**/
this.screenToDocumentPosition = function(screenRow, screenColumn) {
@@ -2317,14 +2211,13 @@ var EditSession = function(text, mode) {
return {row: docRow, column: docColumn};
};
- /** related to: EditSession.screenToDocumentPosition
- * EditSession.documentToScreenPosition(docRow, docColumn) -> Object
- * - docRow (Number): The document row to check
- * - docColumn (Number): The document column to check
- * + (Object): The object returned by this method has two properties: `row` and `column`.
+ /**
+ * @param {Number} docRow The document row to check
+ * @param {Number} docColumn The document column to check
+ * @returns Object} The object returned by this method has two properties: `row` and `column`.
*
* Converts document coordinates to screen coordinates. {:conversionConsiderations}
- *
+ * @related EditSession.screenToDocumentPosition
*
**/
this.documentToScreenPosition = function(docRow, docColumn) {
@@ -2414,28 +2307,18 @@ var EditSession = function(text, mode) {
};
};
- /** internal, hide
- * EditSession.documentToScreenColumn(row, docColumn) -> Number
- *
- *
- **/
+
this.documentToScreenColumn = function(row, docColumn) {
return this.documentToScreenPosition(row, docColumn).column;
};
- /** internal, hide
- * EditSession.documentToScreenRow(docRow, docColumn) -> Number
- *
- *
- **/
this.documentToScreenRow = function(docRow, docColumn) {
return this.documentToScreenPosition(docRow, docColumn).row;
};
/**
- * EditSession.getScreenLength() -> Number
- *
* Returns the length of the screen.
+ * @returns Number
**/
this.getScreenLength = function() {
var screenRows = 0;
diff --git a/lib/ace/multi_select.js b/lib/ace/multi_select.js
index 547463ad..377f018c 100644
--- a/lib/ace/multi_select.js
+++ b/lib/ace/multi_select.js
@@ -324,7 +324,7 @@ var EditSession = require("./edit_session").EditSession;
var Editor = require("./editor").Editor;
(function() {
- /** extension
+ /**
* Editor.updateSelectionMarkers()
*
* Updates the cursor and marker layers.
@@ -334,7 +334,7 @@ var Editor = require("./editor").Editor;
this.renderer.updateBackMarkers();
};
- /** extension
+ /**
* Editor.addSelectionMarker(orientedRange) -> Range
* - orientedRange (Range): A range containing a cursor
*
@@ -352,7 +352,7 @@ var Editor = require("./editor").Editor;
return orientedRange;
};
- /** extension
+ /**
* Editor.removeSelectionMarker(range)
* - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]].
*
@@ -440,7 +440,7 @@ var Editor = require("./editor").Editor;
e.preventDefault();
};
- /** extension
+ /**
* Editor.forEachSelection(cmd, args)
* - cmd (String): The command to execute
* - args (String): Any arguments for the command
@@ -477,7 +477,7 @@ var Editor = require("./editor").Editor;
this.onSelectionChange();
};
- /** extension
+ /**
* Editor.exitMultiSelectMode() -> Void
*
* Removes all the selections except the last added one.
@@ -528,7 +528,7 @@ var Editor = require("./editor").Editor;
}
};
- /** extension
+ /**
* Editor.findAll(needle, options, additive) -> Number
* - needle (String): The text to find
* - options (Object): The search options
@@ -559,14 +559,14 @@ var Editor = require("./editor").Editor;
return ranges.length;
};
- // commands
- /** extension
- * Editor.selectMoreLines(dir, skip)
- * - dir (Number): The direction of lines to select: -1 for up, 1 for down
- * - skip (Boolean): If `true`, removes the active selection range
- *
+ /**
* Adds a cursor above or below the active cursor.
- **/
+ *
+ * @param {Number} dir The direction of lines to select: -1 for up, 1 for down
+ * @param {Boolean} skip If `true`, removes the active selection range
+ *
+ * @method Editor.selectMoreLines
+ */
this.selectMoreLines = function(dir, skip) {
var range = this.selection.toOrientedRange();
var isBackwards = range.cursor == range.end;
@@ -646,7 +646,7 @@ var Editor = require("./editor").Editor;
range.start.row = tmp.start.row;
range.start.column = tmp.start.column;
}
- }
+ };
/** extension
* Editor.selectMore(dir, skip)