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>";
48 methodsSort : function(data)
54 if (data.name.length &&
59 data.isInherited = false;
60 ownMethods.push(data); // should push ctor???
63 var msorted = data.methods.sort(this.makeSortby("name"));
70 //if (/@hide/.test($.desc)) { == not needed - done in the backend
74 //if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
76 // not sure if we should just ignore signletons???
77 //if (!data.isSingleton) {
83 if (data.isSingleton) {
85 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
89 $.isInherited = ($.memberOf != data.name);
95 if ($.isNamespace || (($.memberOf != data.name) && $.isStatic)){
99 $.isInherited = ($.memberOf != data.name);
111 //if (/@hide/.test($.desc)) {
114 // it's a signleton class - can not have dynamic methods..
115 if (data.isSingleton) {
118 if ($.isNamespace || (($.memberOf != data.name) && $.isStatic)){
122 $.isInherited = ($.memberOf != data.alias);
134 method : function(member) {
136 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
137 '<div class="fixedFont"> <span class="attributes">';
139 if (member.isConstructor) {
140 output += "new <B>" + member.memberOf + (member.memberOf.length ? "." : "") +"</B>";
143 if (member.isPrivate) output += "<private> ";
144 if (member.isInner) output += "<inner> ";
145 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
146 output += member.memberOf + ".";
149 output += '</span><b class="itemname">' + member.name + '</b>';
151 output += this.makeSignature(member.params);
152 if (member.returns.length) {
154 for(var i = 0;i< member.returns.length;i++) {
155 var item = member.returns[i];
156 output += (i > 0 ? ' or ' : '') +
157 this.linkSymbol(item.type);
162 output += '</div> <div class="mdesc">';
163 if (!member.isConstructor) {
164 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
167 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
169 output +='<div class="long">';
170 if (!member.isConstructor) {
171 output+= this.resolveLinks(member.desc) ;
172 if (member.example.length) {
173 output +'<pre class="code">'+member.example+'</pre>';
177 output+= 'Create a new '+member.memberOf;
178 // example and desc.. are normally on the 'top'...
180 if (member.params.length) {
183 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
184 for(var i = 0; i < member.params.length ; i++) {
185 var item = member.params[i];
188 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
190 )+ '<b>'+item.name+'</b>';
191 if (item.isOptional) {
192 output+='<i>Optional ';
193 if (item.defaultValue.length) {
194 output+='Default: '+item.defaultValue;
198 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
202 if (member.deprecated.length) {
203 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
204 +member.deprecated+'</dt></dl>';
208 if (member.since.length) {
209 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
210 +member.since+'</dt></dl>';
213 <if test="member.exceptions.length">
214 <dl class="detailList">
215 <dt class="heading">Throws:</dt>
216 <for each="item" in="member.exceptions">
218 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
220 <dd>{+resolveLinks(item.desc)+}</dd>
225 if (member.returns.length) {
226 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
227 for (var i =0; i < member.returns.length; i++) {
228 var item = member.returns[i];
229 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
235 <if test="member.requires.length">
236 <dl class="detailList">
237 <dt class="heading">Requires:</dt>
238 <for each="item" in="member.requires">
239 <dd>{+ resolveLinks(item) +}</dd>
244 if (member.see.length) {
245 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
246 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
248 output +='</div></div>';
254 event : function(member)
258 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
259 '<div class="fixedFont"> ';
262 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
264 output += '<div class="mdesc">';
265 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
268 output += '<div class="long">' + this.resolveLinks(member.desc);
270 if (member.example.length) {
271 output +'<pre class="code">'+member.example+'</pre>';
273 if (member.params.length) {
276 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
277 for(var i = 0; i < member.params.length ; i++) {
278 var item = member.params[i];
281 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
283 )+ '<b>'+item.name+'</b>';
284 if (item.isOptional) {
285 output+='<i>Optional ';
286 if (item.defaultValue.length) {
287 output+='Default: '+item.defaultValue;
291 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
295 if (member.deprecated.length) {
296 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
297 +member.deprecated+'</dt></dl>';
301 if (member.since.length) {
302 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
303 +member.since+'</dt></dl>';
306 <if test="member.exceptions.length">
307 <dl class="detailList">
308 <dt class="heading">Throws:</dt>
309 <for each="item" in="member.exceptions">
311 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
313 <dd>{+resolveLinks(item.desc)+}</dd>
318 if (member.returns.length) {
319 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
320 for (var i =0; i < member.returns.length; i++) {
321 var item = member.returns[i];
322 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
328 <if test="member.requires.length">
329 <dl class="detailList">
330 <dt class="heading">Requires:</dt>
331 <for each="item" in="member.requires">
332 <dd>{+ resolveLinks(item) +}</dd>
337 if (member.see.length) {
338 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
339 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
341 output +='</div></div>';
355 makeSignature : function(params)
358 if (!params.length) return "()";
359 var linkSymbol = this.linkSymbol;
360 var signature = "(" +
363 return $.name.indexOf(".") == -1; // don't show config params in signature
367 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
370 ($.isOptional ? "[" : "") +
373 (typeof($.type) == 'object' ) ? 'Function' : $.type
376 "<B><i>" +$.name + "</i></B>" +
377 ($.defaultValue ? "=" +item.defaultValue : "") +
378 ($.isOptional ? "]" : "");
388 resolveLinks : function(str)
390 if (!str || typeof(str) == 'undefined') {
394 // gtk specific. now..
395 // @ -> bold.. - they are arguments..
397 str = str.replace(/@([a-z_]+)/gi,
398 function(match, symbolName) {
399 return '<b>' + symbolName + '</b>';
403 str = str.replace(/%([a-z_]+)/gi,
404 function(match, symbolName) {
405 return '<b>' + symbolName + '</b>';
409 str = str.replace(/#([a-z_]+)/gi,
410 function(match, symbolName) {
411 return '<b>' + symbolName + '</b>';
412 // this should do a lookup!!!!
413 /// it could use data in the signature to find out..
414 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
418 str = str.replace(/\n/gi, '<br/>');
419 var linkSymbol = this.linkSymbol;
420 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
421 function(match, symbolName) {
422 return linkSymbol(symbolName);
428 summarize : function(desc)
430 if (typeof desc != "undefined") {
431 // finds the first fulls stop...
432 return desc.match(/([\w\W]+?\.)[^a-z0-9]/i)? RegExp.$1.replace("\n", " ") : desc.split("\n")[0];
436 linkSymbol : function(str)
438 return '<span class=\"fixedFont\"><a href="#' + str + '">' + str + '</a></span>';
440 makeSortby : function(attribute) {
441 return function(a, b) {
442 if (a[attribute] != undefined && b[attribute] != undefined) {
443 a = a[attribute]; //.toLowerCase();
444 b = b[attribute];//.toLowerCase();
445 if (a < b) return -1;