JSDOC/BuildDocs.js

[gnome.introspection-doc-generator] / JSDOC / BuildDocs.js
diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js

index 98db57f..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!
  
@@ -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;
-                }
-            }
-        }
+        
          
          
          
@@ -314,7 +315,12 @@ BuildDocs = {
          );
          
      },
-
+    /**
+     * 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...
@@ -350,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
              });
@@ -395,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}";
      }
-     
+       
+ 
      
  };