JSDOC/BuildDocs.js

[gnome.introspection-doc-generator] / JSDOC / BuildDocs.js

diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js
index e85c99c..e06e0a1 100644 (file)
--- a/JSDOC/BuildDocs.js
+++ b/JSDOC/BuildDocs.js
@@ -22,6 +22,17 @@ DocComment  = imports.DocComment.DocComment;
 
 // should not realy be here -- or anywhere...??
 
+function makeSortby(attribute) {
+    return function(a, b) {
+        if (a[attribute] != undefined && b[attribute] != undefined) {
+            a = a[attribute]; //.toLowerCase();
+            b = b[attribute];//.toLowerCase();
+            if (a < b) return -1;
+            if (a > b) return 1;
+            return 0;
+        }
+    }
+}
 
 Options = false; // refer to this everywhere!
 
@@ -137,7 +148,7 @@ BuildDocs = {
 
             var txs = new TextStream(src);
             
-            var tr = new TokenReader({ keepComments : true, keepWhite : true });
+            var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false });
             
             var ts = new TokenStream(tr.tokenize(txs));
         
@@ -191,19 +202,19 @@ BuildDocs = {
         Link.base = "../";
         
         var classTemplate = new Template({
-             templateFile : Options.templateDir  + "/class.tmpl",
+             templateFile : Options.templateDir  + "/class.html",
              Link : Link
         });
         var classesTemplate = new Template({
-            templateFile : Options.templateDir +"/allclasses.tmpl",
+            templateFile : Options.templateDir +"/allclasses.html",
             Link : Link
         });
         var classesindexTemplate = new Template({
-            templateFile : Options.templateDir +"/index.tmpl",
+            templateFile : Options.templateDir +"/index.html",
             Link : Link
         });
         var fileindexTemplate = new Template({   
-            templateFile : Options.templateDir +"/allfiles.tmpl",
+            templateFile : Options.templateDir +"/allfiles.html",
             Link: Link
         });
 
@@ -220,17 +231,7 @@ BuildDocs = {
         function isaClass($) { 
             return ($.is("CONSTRUCTOR") || $.isNamespace); 
         }
-        function makeSortby(attribute) {
-            return function(a, b) {
-                if (a[attribute] != undefined && b[attribute] != undefined) {
-                    a = a[attribute]; //.toLowerCase();
-                    b = b[attribute];//.toLowerCase();
-                    if (a < b) return -1;
-                    if (a > b) return 1;
-                    return 0;
-                }
-            }
-        }
+        
         
         
         
@@ -252,22 +253,26 @@ BuildDocs = {
         
         var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
          
-       var classesIndex = classesTemplate.process(classes); // kept in memory
-        
+         //Options.LOG.inform("classTemplate Process : all classes");
+            
+       // var classesIndex = classesTemplate.process(classes); // kept in memory
         
+        Options.LOG.inform("iterate classes");
         
         for (var i = 0, l = classes.length; i < l; i++) {
             var symbol = classes[i];
             var output = "";
             
+            Options.LOG.inform("classTemplate Process : " + symbol.alias);
+            
             File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
                     classTemplate.process(symbol));
             
-            print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
+            
             
             // dump out a 
             
-            this.publishJSON(Options.target+"/json/",  symbol.alias+'.json', symbol)
+            this.publishJSON(Options.target+"/json/" + symbol.alias+'.json', symbol)
             
             
             
@@ -275,9 +280,9 @@ BuildDocs = {
         
         // regenrate the index with different relative links
         Link.base = "";
-        var classesIndex = classesTemplate.process(classes);
+        //var classesIndex = classesTemplate.process(classes);
         
-          
+        Options.LOG.inform("build index");
         
         File.write(Options.target +  "/index."+ Options.publishExt, 
             classesindexTemplate.process(classes)
@@ -303,12 +308,19 @@ BuildDocs = {
         }
             
         allFiles = allFiles.sort(makeSortby("name"));
-        File.write(Options.target , "/files."+Options.publishExt, 
+        Options.LOG.inform("write files index");
+        
+        File.write(Options.target + "/files."+Options.publishExt, 
             fileindexTemplate.process(allFiles)
         );
         
     },
-
+    /**
+     * JSON files are lookup files for the documentation
+     * - can be used by IDE's or AJAX based doc tools
+     * 
+     * 
+     */
     publishJSON : function(file, data)
     {
         // what we need to output to be usefull...
@@ -344,7 +356,7 @@ BuildDocs = {
             m = ownEvents[i];
             events.push( {
                 name : m.name.substring(1),
-                sig : makeFuncSkel(m.params),
+                sig : this.makeFuncSkel(m.params),
                 type : 'function',
                 desc : m.desc
             });
@@ -371,6 +383,8 @@ BuildDocs = {
     },
     makeSrcFile: function(sourceFile) 
     {
+        // this stuff works...
+        return;
         
         
         name = sourceFile.substring(Options.baseDir.length+1);
@@ -387,8 +401,22 @@ BuildDocs = {
             '</head><body class="highlightpage">' +
             pretty +
             '</body></html>');
+    },
+    /**
+     * used by JSON output to generate a function skeleton
+     */
+    makeFuncSkel :function(params) {
+        if (!params) return "function ()\n{\n\n}";
+        return "function ("    +
+            params.filter(
+                function($) {
+                    return $.name.indexOf(".") == -1; // don't show config params in signature
+                }
+            ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +
+        ")\n{\n\n}";
     }
-     
+       
+ 
     
 };