5 summary : function (data)
8 output = this.resolveLinks(data.desc) ;
9 if (data.example.length) {
10 output += '<pre class="code">'+data.example+'</pre>';
17 augments : function(data)
19 if (!data.augments.length) {
22 var linkSymbol = this.linkSymbol;
23 var output = '<div class="inheritance res-block"> <pre class="res-block-inner">';
25 var iblock_indent = 0;
26 data.augments.reverse().map(
28 output += iblock_indent ? ('<img src="../images/default/s.gif" height="1" width="' +
29 iblock_indent + '"/><img src="../images/default/tree/elbow-end.gif" class="elbow"/>') : '';
30 output += linkSymbol($) + "\n";
35 return output + '<img src="../images/default/s.gif" height="1" width="' + iblock_indent +'"/>' +
36 '<img class="elbow" src="../images/default/tree/elbow-end.gif"/>'+data.name+
42 implementors : function(data)
44 if (!data.childClasses || typeof(data.childClasses[data.name]) == 'undefined') {
47 var linkSymbol = this.linkSymbol;
48 //var linkSymbol = this.linkSymbol;
49 var output = '<ul class="inheritance res-block"> ';
51 var iterArray = function(ar) {
52 for(var i = 0; i < ar.length; i++) {
53 output += '<li>' +linkSymbol(ar[i]) ; // a href...
54 if (typeof(data.childClasses[ar[i]]) != 'undefined') {
56 iterArray(data.childClasses[ar[i]]);
64 iterArray(data.childClasses[data.name]);
66 return output + '</ul>'
70 doc_children : function(data)
72 if (!data.tree_children || data.tree_children < 1) {
76 var ar = data.tree_children;
79 var linkSymbol = this.linkSymbol;
80 //var linkSymbol = this.linkSymbol;
81 var output = '<ul class="doc-children-list res-block"> ';
82 ar.sort(function (a, b) {
83 return a.toLowerCase().localeCompare(b.toLowerCase());
85 for(var i = 0; i < ar.length; i++) {
86 output += '<li>' +linkSymbol(ar[i]) + "</li>";
93 return output + '</ul>'
98 config : function(dtag)
101 var output = '<a name="'+dtag.memberOf+'-cfg-'+dtag.name+'"></a>';
102 output += '<div class="fixedFont"><b class="itemname"> ' + dtag.name + '</b> : ' +
103 (dtag.type.length ? this.linkSymbol(dtag.type) : "" ) + '</div>';
105 output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
107 output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' +
108 (dtag.values && dtag.values.length ? ("<BR/>Possible Values: " +
109 dtag.values.map(function(v) {
110 return v.length ? v : "<B>Empty</B>";
113 Roo.log(JSON.stringify(output));
117 methodsSort : function(data)
123 if (data.name.length &&
129 data.isInherited = false;
130 data.isConstructor = true;
131 ownMethods.push(data); // should push ctor???
134 var msorted = data.methods.sort(this.makeSortby("name"));
141 if (!$.memberOf.length) {
142 $.memberOf = data.name;
146 if (data.isSingleton) {
148 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
152 $.isInherited = (memberOf != data.name);
158 if (($.memberOf != data.name) && $.isStatic){
162 $.isInherited = ($.memberOf != data.name);
174 //if (/@hide/.test($.desc)) {
177 // it's a signleton class - can not have dynamic methods..
178 if (data.isSingleton) {
181 if (($.memberOf != data.name) && $.isStatic){
185 $.isInherited = ($.memberOf != data.alias);
198 method : function(member) {
200 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
201 '<div class="fixedFont"> <span class="attributes">';
203 if (member.isConstructor) {
207 if (member.isPrivate) output += "<private> ";
208 if (member.isInner) output += "<inner> ";
209 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
210 output += member.memberOf + ".";
213 output += '</span><b class="itemname">' + member.name + '</b>';
215 output += this.makeSignature(member.params);
216 if (member.returns && member.returns.length) {
218 for(var i = 0;i< member.returns.length;i++) {
219 var item = member.returns[i];
220 output += (i > 0 ? ' or ' : '') +
221 this.linkSymbol(item.type);
226 output += '</div> <div class="mdesc">';
227 if (!member.isConstructor) {
228 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
231 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
233 output +='<div class="long">';
234 if (!member.isConstructor) {
235 output+= this.resolveLinks(member.desc) ;
236 if (member.example.length) {
237 output += '<pre class="code">'+member.example+'</pre>';
241 output+= 'Create a new '+member.memberOf;
242 // example and desc.. are normally on the 'top'...
244 if (member.params.length) {
247 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
248 for(var i = 0; i < member.params.length ; i++) {
249 var item = member.params[i];
252 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
254 )+ '<b>'+item.name+'</b>';
255 if (item.isOptional) {
256 output+='<i>Optional ';
257 if (item.defaultValue.length) {
258 output+='Default: '+item.defaultValue;
262 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
266 if (member.isDeprecated || (member.deprecated && member.deprecated.length)) {
267 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
268 +member.deprecated+'</dt></dl>';
272 if (member.since && member.since.length) {
273 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
274 +member.since+'</dt></dl>';
277 <if test="member.exceptions.length">
278 <dl class="detailList">
279 <dt class="heading">Throws:</dt>
280 <for each="item" in="member.exceptions">
282 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
284 <dd>{+resolveLinks(item.desc)+}</dd>
289 if (member.returns && member.returns.length) {
290 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
291 for (var i =0; i < member.returns.length; i++) {
292 var item = member.returns[i];
293 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
299 <if test="member.requires.length">
300 <dl class="detailList">
301 <dt class="heading">Requires:</dt>
302 <for each="item" in="member.requires">
303 <dd>{+ resolveLinks(item) +}</dd>
308 if (member.see && member.see.length) {
309 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
310 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
312 output +='</div></div>';
318 event : function(member)
322 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
323 '<div class="fixedFont"> ';
326 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
328 output += '<div class="mdesc">';
329 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
332 output += '<div class="long">' + this.resolveLinks(member.desc);
334 if (member.example.length) {
335 output +='<pre class="code">'+member.example+'</pre>';
337 if (member.params.length) {
340 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
341 for(var i = 0; i < member.params.length ; i++) {
342 var item = member.params[i];
345 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
347 )+ '<b>'+item.name+'</b>';
348 if (item.isOptional) {
349 output+='<i>Optional ';
350 if (item.defaultValue.length) {
351 output+='Default: '+item.defaultValue;
355 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
359 if ((member.deprecated && member.deprecated.length) || member.isDeprecated) {
360 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
361 +member.deprecated+'</dt></dl>';
365 if (member.since && member.since.length) {
366 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
367 +member.since+'</dt></dl>';
370 <if test="member.exceptions.length">
371 <dl class="detailList">
372 <dt class="heading">Throws:</dt>
373 <for each="item" in="member.exceptions">
375 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
377 <dd>{+resolveLinks(item.desc)+}</dd>
382 if (member.returns && member.returns.length) {
383 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
384 for (var i =0; i < member.returns.length; i++) {
385 var item = member.returns[i];
386 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
392 <if test="member.requires.length">
393 <dl class="detailList">
394 <dt class="heading">Requires:</dt>
395 <for each="item" in="member.requires">
396 <dd>{+ resolveLinks(item) +}</dd>
401 if (member.see && member.see.length) {
402 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
403 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
405 output +='</div></div>';
419 makeSignature : function(params)
422 if (!params.length) return "()";
423 var linkSymbol = this.linkSymbol;
424 var signature = " (" +
427 return $.name.indexOf(".") == -1; // don't show config params in signature
431 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
434 ($.isOptional ? "[" : "") +
437 (typeof($.type) == 'object' ) ? 'Function' : $.type
440 "<B><i>" +$.name + "</i></B>" +
441 ($.defaultValue ? "=" +item.defaultValue : "") +
442 ($.isOptional ? "]" : "");
452 resolveLinks : function(str)
454 if (!str || typeof(str) == 'undefined') {
458 // gtk specific. now..
459 // @ -> bold.. - they are arguments..
461 str = str.replace(/@([a-z_]+)/gi,
462 function(match, symbolName) {
463 return '<b>' + symbolName + '</b>';
467 str = str.replace(/%([a-z_]+)/gi,
468 function(match, symbolName) {
469 return '<b>' + symbolName + '</b>';
473 str = str.replace(/#([a-z_]+)/gi,
474 function(match, symbolName) {
475 return '<b>' + symbolName + '</b>';
476 // this should do a lookup!!!!
477 /// it could use data in the signature to find out..
478 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
482 //Roo.log(JSON.stringify(str));
483 str = str.replace(/[ \t]+\n/gi, '\n');
484 str = str.replace(/\n\n+/gi, '<br/><br/>');
485 //str = str.replace(/\n/gi, '<br/>');
486 var linkSymbol = this.linkSymbol;
487 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
488 function(match, symbolName) {
489 return linkSymbol(symbolName);
495 summarize : function(desc)
497 if (typeof desc != "undefined") {
498 // finds the first fulls stop... (and we remove '<' html...)
499 return desc.match(/([\w\W]+?[\.|:])[^a-z0-9]/i)?
500 RegExp.$1.split('<')[0].replace("\n", " ") : desc.split("\n")[0];
504 linkSymbol : function(str)
507 var ar = str.split('<');
509 for(var i = ar.length-1; i > -1; i--) {
510 var bit = ar[i].split('>').shift();
512 out = '<' + out + '>';
514 out = '<span class=\"fixedFont\"><a href="#' + bit+ '">' + bit + '</a>' + out + '</span>';
519 makeSortby : function(attribute) {
520 return function(a, b) {
521 if (a[attribute] != undefined && b[attribute] != undefined) {
522 a = a[attribute]; //.toLowerCase();
523 b = b[attribute];//.toLowerCase();
524 if (a < b) return -1;