' + sourceFile + '

X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=a4a764085f05dc7ee5f8ffe9cc781b5560eb28c7;hp=cb46ee76c98fc121a3d7491c91d63552566314d4;hb=4d913cd3aeeb83d819b92049f469d742f09e361b;hpb=0192c8563613030f3c612668ad49d516d1f5ef76 diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index cb46ee7..a4a7640 100644 --- a/JSDOC/BuildDocs.js +++ b/JSDOC/BuildDocs.js @@ -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, '' + '' + sourceFile + '' + @@ -401,8 +411,22 @@ BuildDocs = { '' + pretty + ''); + }, + /** + * 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}"; } - + + };