X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=024d628a809853872438bbdcf66502d5fe95f143;hp=f514e9f3e4f311e50052a40528774ab3a1d53476;hb=25f36ac6f41ae48994b75fd710b5fb9bfc851727;hpb=8bc505aa019f7e4b56216fffa67a8bead2f339be diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index f514e9f..024d628 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! @@ -137,7 +148,7 @@ BuildDocs = { var txs = new TextStream(src); - var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: 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; - } - } - } + @@ -271,7 +272,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 +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 }); @@ -378,16 +384,18 @@ BuildDocs = { makeSrcFile: function(sourceFile) { // this stuff works... - return; - + - name = sourceFile.substring(Options.baseDir.length+1); + print("SF: " + sourceFile); + var name = sourceFile.substring(Options.baseDir.length+1); + print("SHORT NAME: " + name); name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); - + print("SHORT NAME _: " + name); name = name.replace(/\:/g, "_"); //?? + print("SHORT NAME :: " + name); 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 + '' + @@ -395,8 +403,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}"; } - + + };