JSDOC/BuildDocs.js
[gnome.introspection-doc-generator] / JSDOC / BuildDocs.js
index cb46ee7..a4a7640 100644 (file)
@@ -201,20 +201,22 @@ BuildDocs = {
         Link.symbolSet = this.symbolSet;
         Link.base = "../";
         
+        Link.srcFileFlatName = this.srcFileFlatName;
+        
         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
         });
 
@@ -356,7 +358,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
             });
@@ -381,19 +383,27 @@ BuildDocs = {
         
         
     },
+    srcFileRelName : function(sourceFile)
+    {
+      return sourceFile.substring(Options.baseDir.length+1);
+    },
+    srcFileFlatName: function(sourceFile)
+    {
+        var name = this.srcFileRelName(sourceFile);
+        name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
+        return name.replace(/\:/g, "_"); //??
+        
+    },
+    
     makeSrcFile: function(sourceFile) 
     {
         // this stuff works...
-        return;
-        
-        
-        name = sourceFile.substring(Options.baseDir.length+1);
-        name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
+     
         
-        name = name.replace(/\:/g, "_"); //??
+        var name = this.srcFileFlatName(sourceFile);
         
         Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name);
-        var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile));
+        var pretty = imports.PrettyPrint.toPretty(File.read(  sourceFile));
         File.write(Options.target+"/symbols/src/" + name, 
             '<html><head>' +
             '<title>' + sourceFile + '</title>' +
@@ -401,8 +411,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}";
     }
-     
+       
     
 };