sync
[roojs1] / docs / Roo.docs.template.js
index 02b2bd1..373e953 100644 (file)
@@ -39,6 +39,62 @@ Roo.docs.template  = {
        
     },
     
+    implementors : function(data)
+    {
+               if (!data.childClasses || typeof(data.childClasses[data.name]) == 'undefined') { 
+                       return '';
+               }
+               var linkSymbol  = this.linkSymbol;
+               //var linkSymbol  = this.linkSymbol;
+               var output = '<ul class="inheritance res-block"> ';
+               
+               var iterArray  = function(ar) {
+                       for(var i = 0; i < ar.length; i++) {
+                               output += '<li>' +linkSymbol(ar[i]) ; // a href...
+                               if (typeof(data.childClasses[ar[i]]) != 'undefined') {
+                                       output += '<ul>';
+                                       iterArray(data.childClasses[ar[i]]);
+                                       output += '</ul>';
+                               }
+                               output +=  "</li>";
+                               
+                       }
+                       
+               }
+               iterArray(data.childClasses[data.name]);
+                
+               return output +   '</ul>'
+       
+    },
+       
+       doc_children : function(data)
+    {
+               if (!data.tree_children ||  data.tree_children < 1) { 
+                       return '';
+               }
+               
+               var ar = data.tree_children;
+               
+               
+               var linkSymbol  = this.linkSymbol;
+               //var linkSymbol  = this.linkSymbol;
+               var output = '<ul class="doc-children-list res-block"> ';
+               ar.sort(function (a, b) {
+                       return a.toLowerCase().localeCompare(b.toLowerCase());
+               })
+               for(var i = 0; i < ar.length; i++) {
+                       output += '<li>' +linkSymbol(ar[i])  + "</li>";
+                       
+               }
+               
+       
+               
+                
+               return output +   '</ul>'
+       
+    },
+       
+    
     config : function(dtag)
     {
        
@@ -49,7 +105,7 @@ Roo.docs.template  = {
        output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
                
        output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' + 
-                       (dtag.values.length ? ("<BR/>Possible Values: " +
+                       (dtag.values && dtag.values.length ? ("<BR/>Possible Values: " +
                    dtag.values.map(function(v) {
                        return v.length ? v : "<B>Empty</B>";
                    }).join(", ")) : ''
@@ -67,7 +123,8 @@ Roo.docs.template  = {
        if (data.name.length && 
            !data.isBuiltin && 
            !data.isSingleton &&
-           !data.isStatic
+           !data.isStatic &&
+           !data.isFlutter
            ) {
            data.isInherited = false;
            data.isConstructor = true;
@@ -80,17 +137,7 @@ Roo.docs.template  = {
        
        msorted.filter(
            function($){
-               
-           //if (/@hide/.test($.desc)) { == not needed - done in the backend
-           //    return false;
-           //}
-               
-           //if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
-           
-           // not sure if we should just ignore signletons???
-           //if (!data.isSingleton) {
-           //    return true; 
-           //}
+        
            
            
            
@@ -116,7 +163,7 @@ Roo.docs.template  = {
                
            return true;
            }
-           );
+       );
     
        // then dynamics..
     
@@ -164,11 +211,11 @@ Roo.docs.template  = {
         output += '</span><b class="itemname">' + member.name + '</b>';
                 
         output += this.makeSignature(member.params);
-        if (member.returns.length) {
+        if (member.returns && member.returns.length) {
             output += ': ';
-        for(var i = 0;i< member.returns.length;i++) {
-           var item = member.returns[i];
-           output += (i > 0 ? ' or ' : '') +
+           for(var i = 0;i< member.returns.length;i++) {
+               var item = member.returns[i];
+               output += (i > 0 ? ' or ' : '') +
                this.linkSymbol(item.type);
            }
         }
@@ -180,7 +227,7 @@ Roo.docs.template  = {
         } else  {
             //ctor
         output+= '<div class="short">Create a new '+member.memberOf +'</div>';
-        }
+    }
     output +='<div class="long">';
         if (!member.isConstructor) {
             output+= this.resolveLinks(member.desc) ;
@@ -214,13 +261,13 @@ Roo.docs.template  = {
             }
             output+= '</dl>';
         }    
-        if (member.deprecated.length) {
+        if (member.isDeprecated || (member.deprecated && member.deprecated.length)) {
             output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
                         +member.deprecated+'</dt></dl>';
         }
         
         
-        if (member.since.length) {
+        if (member.since && member.since.length) {
             output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
                         +member.since+'</dt></dl>';
         }
@@ -237,7 +284,7 @@ Roo.docs.template  = {
                         </dl>
                 </if>
                 */
-        if (member.returns.length) {
+        if (member.returns && member.returns.length) {
             output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
         for (var i =0; i < member.returns.length; i++) {
         var item = member.returns[i];
@@ -256,7 +303,7 @@ Roo.docs.template  = {
                         </dl>
                 </if>
         */
-        if (member.see.length) {
+        if (member.see  && member.see.length) {
             output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
                         '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
         }
@@ -307,13 +354,13 @@ Roo.docs.template  = {
             }
             output+= '</dl>';
         }            
-      if (member.deprecated.length) {
+      if ((member.deprecated && member.deprecated.length) || member.isDeprecated) {
             output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
                         +member.deprecated+'</dt></dl>';
         }
         
         
-        if (member.since.length) {
+        if (member.since && member.since.length) {
             output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
                         +member.since+'</dt></dl>';
         }
@@ -330,7 +377,7 @@ Roo.docs.template  = {
                         </dl>
                 </if>
                 */    
-      if (member.returns.length) {
+      if (member.returns && member.returns.length) {
             output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
         for (var i =0; i < member.returns.length; i++) {
         var item = member.returns[i];
@@ -349,7 +396,7 @@ Roo.docs.template  = {
                         </dl>
                 </if>
         */
-        if (member.see.length) {
+        if (member.see && member.see.length) {
             output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
                         '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
         }
@@ -454,7 +501,18 @@ Roo.docs.template  = {
     },
     linkSymbol : function(str)
     {
-        return '<span class=\"fixedFont\"><a href="#' + str + '">' + str + '</a></span>';
+        Roo.log(str);
+       var ar = str.split('<');
+       var out = '';
+       for(var i = ar.length-1; i > -1; i--) {
+           var bit = ar[i].split('>').shift();
+           if (out.length) {
+               out = '&lt;' + out + '&gt;';
+           }
+           out = '<span class=\"fixedFont\"><a href="#' + bit+ '">' + bit + '</a>' + out + '</span>';
+       }
+       
+       return out;
     },
     makeSortby : function(attribute) {
        return function(a, b) {