5 augments : function(data)
7 if (!data.augments.length) {
10 var linkSymbol = this.linkSymbol;
11 var output = '<div class="inheritance res-block"> <pre class="res-block-inner">';
13 var iblock_indent = 0;
14 data.augments.reverse().map(
16 output += iblock_indent ? ('<img src="../images/default/s.gif" height="1" width="' +
17 iblock_indent + '"/><img src="../images/default/tree/elbow-end.gif" class="elbow"/>') : '';
18 output += linkSymbol($) + "\n";
23 return output + '<img src="../images/default/s.gif" height="1" width="' + iblock_indent +'"/>' +
24 '<img class="elbow" src="../images/default/tree/elbow-end.gif"/>'+data.name+
30 config : function(dtag)
33 var output = '<a name="'+dtag.memberOf+'-cfg-'+dtag.name+'"></a>';
34 output += '<div class="fixedFont"><b class="itemname"> ' + dtag.name + '</b> : ' +
35 (dtag.type.length ? this.linkSymbol(dtag.type) : "" ) + '</div>';
37 output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
39 output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' +
40 (dtag.values.length ? ("<BR/>Possible Values: " +
41 dtag.values.map(function(v) {
42 return v.length ? v : "<B>Empty</B>";
45 Roo.log(JSON.stringify(output));
49 methodsSort : function(data)
55 if (data.name.length &&
60 data.isInherited = false;
61 data.isConstructor = true;
62 ownMethods.push(data); // should push ctor???
65 var msorted = data.methods.sort(this.makeSortby("name"));
72 //if (/@hide/.test($.desc)) { == not needed - done in the backend
76 //if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
78 // not sure if we should just ignore signletons???
79 //if (!data.isSingleton) {
85 if (data.isSingleton) {
87 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
91 $.isInherited = ($.memberOf != data.name);
97 if (($.memberOf != data.name) && $.isStatic){
101 $.isInherited = ($.memberOf != data.name);
113 //if (/@hide/.test($.desc)) {
116 // it's a signleton class - can not have dynamic methods..
117 if (data.isSingleton) {
120 if (($.memberOf != data.name) && $.isStatic){
124 $.isInherited = ($.memberOf != data.alias);
137 method : function(member) {
139 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
140 '<div class="fixedFont"> <span class="attributes">';
142 if (member.isConstructor) {
146 if (member.isPrivate) output += "<private> ";
147 if (member.isInner) output += "<inner> ";
148 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
149 output += member.memberOf + ".";
152 output += '</span><b class="itemname">' + member.name + '</b>';
154 output += this.makeSignature(member.params);
155 if (member.returns.length) {
157 for(var i = 0;i< member.returns.length;i++) {
158 var item = member.returns[i];
159 output += (i > 0 ? ' or ' : '') +
160 this.linkSymbol(item.type);
165 output += '</div> <div class="mdesc">';
166 if (!member.isConstructor) {
167 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
170 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
172 output +='<div class="long">';
173 if (!member.isConstructor) {
174 output+= this.resolveLinks(member.desc) ;
175 if (member.example.length) {
176 output +'<pre class="code">'+member.example+'</pre>';
180 output+= 'Create a new '+member.memberOf;
181 // example and desc.. are normally on the 'top'...
183 if (member.params.length) {
186 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
187 for(var i = 0; i < member.params.length ; i++) {
188 var item = member.params[i];
191 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
193 )+ '<b>'+item.name+'</b>';
194 if (item.isOptional) {
195 output+='<i>Optional ';
196 if (item.defaultValue.length) {
197 output+='Default: '+item.defaultValue;
201 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
205 if (member.deprecated.length) {
206 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
207 +member.deprecated+'</dt></dl>';
211 if (member.since.length) {
212 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
213 +member.since+'</dt></dl>';
216 <if test="member.exceptions.length">
217 <dl class="detailList">
218 <dt class="heading">Throws:</dt>
219 <for each="item" in="member.exceptions">
221 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
223 <dd>{+resolveLinks(item.desc)+}</dd>
228 if (member.returns.length) {
229 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
230 for (var i =0; i < member.returns.length; i++) {
231 var item = member.returns[i];
232 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
238 <if test="member.requires.length">
239 <dl class="detailList">
240 <dt class="heading">Requires:</dt>
241 <for each="item" in="member.requires">
242 <dd>{+ resolveLinks(item) +}</dd>
247 if (member.see.length) {
248 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
249 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
251 output +='</div></div>';
257 event : function(member)
261 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
262 '<div class="fixedFont"> ';
265 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
267 output += '<div class="mdesc">';
268 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
271 output += '<div class="long">' + this.resolveLinks(member.desc);
273 if (member.example.length) {
274 output +'<pre class="code">'+member.example+'</pre>';
276 if (member.params.length) {
279 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
280 for(var i = 0; i < member.params.length ; i++) {
281 var item = member.params[i];
284 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
286 )+ '<b>'+item.name+'</b>';
287 if (item.isOptional) {
288 output+='<i>Optional ';
289 if (item.defaultValue.length) {
290 output+='Default: '+item.defaultValue;
294 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
298 if (member.deprecated.length) {
299 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
300 +member.deprecated+'</dt></dl>';
304 if (member.since.length) {
305 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
306 +member.since+'</dt></dl>';
309 <if test="member.exceptions.length">
310 <dl class="detailList">
311 <dt class="heading">Throws:</dt>
312 <for each="item" in="member.exceptions">
314 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
316 <dd>{+resolveLinks(item.desc)+}</dd>
321 if (member.returns.length) {
322 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
323 for (var i =0; i < member.returns.length; i++) {
324 var item = member.returns[i];
325 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
331 <if test="member.requires.length">
332 <dl class="detailList">
333 <dt class="heading">Requires:</dt>
334 <for each="item" in="member.requires">
335 <dd>{+ resolveLinks(item) +}</dd>
340 if (member.see.length) {
341 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
342 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
344 output +='</div></div>';
358 makeSignature : function(params)
361 if (!params.length) return "()";
362 var linkSymbol = this.linkSymbol;
363 var signature = "(" +
366 return $.name.indexOf(".") == -1; // don't show config params in signature
370 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
373 ($.isOptional ? "[" : "") +
376 (typeof($.type) == 'object' ) ? 'Function' : $.type
379 "<B><i>" +$.name + "</i></B>" +
380 ($.defaultValue ? "=" +item.defaultValue : "") +
381 ($.isOptional ? "]" : "");
391 resolveLinks : function(str)
393 if (!str || typeof(str) == 'undefined') {
397 // gtk specific. now..
398 // @ -> bold.. - they are arguments..
400 str = str.replace(/@([a-z_]+)/gi,
401 function(match, symbolName) {
402 return '<b>' + symbolName + '</b>';
406 str = str.replace(/%([a-z_]+)/gi,
407 function(match, symbolName) {
408 return '<b>' + symbolName + '</b>';
412 str = str.replace(/#([a-z_]+)/gi,
413 function(match, symbolName) {
414 return '<b>' + symbolName + '</b>';
415 // this should do a lookup!!!!
416 /// it could use data in the signature to find out..
417 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
421 //Roo.log(JSON.stringify(str));
422 str = str.replace(/[ \t]+\n/gi, '\n');
423 str = str.replace(/\n\n+/gi, '<br/><br/>');
424 //str = str.replace(/\n/gi, '<br/>');
425 var linkSymbol = this.linkSymbol;
426 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
427 function(match, symbolName) {
428 return linkSymbol(symbolName);
434 summarize : function(desc)
436 if (typeof desc != "undefined") {
437 // finds the first fulls stop... (and we remove '<' html...)
438 return desc.match(/([\w\W]+?[\.|:])[^a-z0-9]/i)?
439 RegExp.$1.split('<')[0].replace("\n", " ") : desc.split("\n")[0];
443 linkSymbol : function(str)
445 return '<span class=\"fixedFont\"><a href="#' + str + '">' + str + '</a></span>';
447 makeSortby : function(attribute) {
448 return function(a, b) {
449 if (a[attribute] != undefined && b[attribute] != undefined) {
450 a = a[attribute]; //.toLowerCase();
451 b = b[attribute];//.toLowerCase();
452 if (a < b) return -1;