X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=21a1f6fa07d1d20572eafc9245976d8c7b3877c6;hp=9d206910462f662b3cd4f5a2b90b6f02b5b02ed3;hb=a0aaaf1f4c0b40c6d613c61d89f2049321f1020d;hpb=67766489c88102cf1eab47d22582d52c05e51b46 diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index 9d20691..21a1f6f 100644 --- 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! @@ -190,20 +201,22 @@ BuildDocs = { Link.symbolSet = this.symbolSet; Link.base = "../"; + Link.symbolToSrcFileName = this.symbolToSrcFileName; + 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 +233,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; - } - } - } + @@ -271,7 +274,7 @@ BuildDocs = { // dump out a - this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol) + this.publishJSON(Options.target+"/json/" + symbol.alias+'.json', symbol) @@ -314,7 +317,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 +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 }); @@ -375,16 +383,20 @@ BuildDocs = { }, - makeSrcFile: function(sourceFile) + + symbolToSrcFileName : function(sourceFile) { - // this stuff works... - return; - - - name = sourceFile.substring(Options.baseDir.length+1); + var name = sourceFile.substring(Options.baseDir.length+1); name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); name = name.replace(/\:/g, "_"); //?? + }, + + makeSrcFile: function(sourceFile) + { + // this stuff works... + var name = this.symbolToSrcFileName(sourceFile); + Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name); var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile)); @@ -395,8 +407,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}"; } - + + };