X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=eb39bf98428c8a3d7b877c8c8682af8b3f5b7621;hb=723fb71d74c6b1da27fa7447b3efdff78166a283;hp=2f16d204040a4b582b56c5d9a7154f1db04c406e;hpb=92b69382f0f739831b7a8dd6aca47d9e634df359;p=gnome.introspection-doc-generator diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index 2f16d20..eb39bf9 100644 --- a/JSDOC/BuildDocs.js +++ b/JSDOC/BuildDocs.js @@ -10,9 +10,9 @@ File = imports.File.File; Template = imports.JsTemplate.Template.Template; -Options = imports.Options.Options; -Parser = imports.Parser.Parser; +Parser = imports.Parser.Parser; +TextStream = imports.TextStream.TextStream; TokenReader = imports.TokenReader.TokenReader; TokenStream = imports.TokenStream.TokenStream; Symbol = imports.Symbol.Symbol; @@ -21,7 +21,7 @@ Symbol = imports.Symbol.Symbol; // should not realy be here -- or anywhere...?? - +Options = false; // refer to this everywhere! BuildDocs = { @@ -31,20 +31,16 @@ BuildDocs = { srcFiles : [], + build : function (opts) { - - XObject.extend(Options, opts); - + Options = opts; Options.init(); - - - Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+"."); - Options.LOG.inform("With options: "); + //Options.LOG.inform("With options: "); - if (!File.isDirectory(Options.cacheDirectory)) { + if (Options.cacheDirectory.length && !File.isDirectory(Options.cacheDirectory)) { File.mkdir(Options.cacheDirectory) } @@ -71,18 +67,21 @@ BuildDocs = { } for (var i = 0; i < Options.src.length; i++) { - this.srcFiles = this.srcFiles.concat( + // add to sourcefiles.. - File.list(Options.src[i] ).filter( - function($) { - var thisExt = $.split(".").pop().toLowerCase(); - return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers); - // we're only interested in files with certain extensions - } - ) - ); + File.list(Options.src[i] ).forEach($) { + if (Options['exclude-src'].indexOf($) > -1) { + return; + } + var thisExt = $.split(".").pop().toLowerCase(); + if (ext.indexOf(thisExt) < 0) { + return; + } + this.srcFiles.push(Options.src[i] + '/' + $); + }); + } - + Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit(); return this.srcFiles; }, @@ -126,16 +125,19 @@ BuildDocs = { var src = '' try { + Options.LOG.warn("reading : " + srcFile); src = File.read(srcFile); } catch(e) { - LOG.warn("Can't read source file '"+srcFile+"': "+e.message); + Options.LOG.warn("Can't read source file '"+srcFile+"': "+e.message); continue; } - - var tr = new TokenReader(); - var ts = new TokenStream(tr.tokenize(src)); + var txs = new TextStream(src); + + var tr = new TokenReader({ keepComments : true, keepWhite : true }); + + var ts = new TokenStream(tr.tokenize(txs)); Parser.parse(ts, srcFile); @@ -151,7 +153,7 @@ BuildDocs = { Parser.finish(); - } + }, @@ -173,20 +175,31 @@ BuildDocs = { File.list(Options.templatesDir + '/static').forEach(function (f) { File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f); }); - + if (!File.isDirectory(Options.target +"/json")) { + File.makeDir(Options.target +"/json"); + } // used to check the details of things being linked to Link.symbolSet = symbolSet; - + Link.base = "../"; var classTemplate = new Template({ templateFile : Options.templatesDir + "/class.tmpl", Link : Link }); - var classesTemplate = new Template( - templateFile : Options.templatesDir +"allclasses.tmpl", + var classesTemplate = new Template({ + templateFile : Options.templatesDir +"/allclasses.tmpl", Link : Link - ); + }); + var classesindexTemplate = new Template({ + templateFile : Options.templatesDir +"/index.tmpl", + Link : Link + }); + var fileindexTemplate = new Template({ + templateFile : Options.templatesDir +"/allfiles.tmpl", + Link: Link + }); + classTemplate.symbolSet = symbolSet; @@ -207,16 +220,15 @@ BuildDocs = { for (var i = 0, l = files.length; i < l; i++) { var file = files[i]; - var srcDir = publish.conf.outDir + "symbols/src/"; - makeSrcFile(file, srcDir); + var targetDir = Options.target + "/symbols/src/"; + this.makeSrcFile(file, targetDir); } var classes = symbols.filter(isaClass).sort(makeSortby("alias")); + + var classesIndex = classesTemplate.process(classes); // kept in memory - Link.base = "../"; - publish.classesIndex = classesTemplate.process(classes); // kept in memory - IO.makeDir(publish.conf.outDir+"json"); for (var i = 0, l = classes.length; i < l; i++) { var symbol = classes[i]; @@ -225,37 +237,38 @@ BuildDocs = { File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt , classTemplate.process(symbol)); - println("write " + Options.target+"/symbols/" +symbol.alias+publish.conf.ext); - IO.saveFile(publish.conf.outDir+"symbols/", symbol.alias+publish.conf.ext, output); + print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt); + // dump out a - IO.saveFile(publish.conf.outDir+"json/", symbol.alias+'.json' , publish.jsonRender(symbol)); + + this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol) + } // regenrate the index with different relative links Link.base = ""; - publish.classesIndex = classesTemplate.process(classes); + var classesIndex = classesTemplate.process(classes); - try { - var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl"); - } - catch(e) { print(e.message); quit(); } + - var classesIndex = classesindexTemplate.process(classes); - IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex); - classesindexTemplate = classesIndex = classes = null; + File.write(Options.target + "/index."+ Options.publishExt, + classesindexTemplate.process(classes) + ); - try { - var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl"); - } - catch(e) { print(e.message); quit(); } + // blank everything???? classesindexTemplate = classesIndex = classes = null; + + + + var documentedFiles = symbols.filter(function ($) { + return ($.is("FILE")) + }); - var documentedFiles = symbols.filter(isaFile); var allFiles = []; for (var i = 0; i < files.length; i++) { - allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); + allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); } for (var i = 0; i < documentedFiles.length; i++) { @@ -264,13 +277,90 @@ BuildDocs = { } allFiles = allFiles.sort(makeSortby("name")); + File.write(Options.target , "/files."+Options.publishExt, + fileindexTemplate.process(allFiles) + ); + + }, - var filesIndex = fileindexTemplate.process(allFiles); - IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex); - fileindexTemplate = filesIndex = files = null; - } + publishJSON : function(file, data) + { + // what we need to output to be usefull... + // a) props.. + var cfgProperties = []; + if (!data.comment.getTag('singleton').length) { + cfgProperties = data.configToArray(); + cfgProperties = cfgProperties.sort(makeSortby("name")); + + } + var props = []; + //println(cfgProperties.toSource()); + var p =''; + for(var i =0; i < cfgProperties.length;i++) { + p = cfgProperties[i]; + props.push( { + name : p.name, + type : p.type, + desc : p.desc, + memberOf : p.memberOf == data.alias ? '' : p.memberOf + }); + } + + + var ownEvents = data.methods.filter( function(e){ + return e.isEvent && !e.comment.getTag('hide').length; + }).sort(makeSortby("name")); + + + var events = []; + var m; + for(var i =0; i < ownEvents.length;i++) { + m = ownEvents[i]; + events.push( { + name : m.name.substring(1), + sig : makeFuncSkel(m.params), + type : 'function', + desc : m.desc + }); + } + //println(props.toSource()); + // we need to output: + //classname => { + // propname => + // type=> + // desc=> + // } - + var ret = { + props : props, + events: events + }; + File.write(file, JSON.stringify(ret, null, 2 )); + + + // b) methods + // c) events + + + }, + makeSrcFile: function(sourceFile) + { + + + name = sourceFile.substring(Options.baseDir.length); + name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); + name = name.replace(/\:/g, "_"); //?? + + + var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile)); + File.write(Options.target+"/symbols/src/" + name, + '' + + '' + sourceFile + '' + + '' + + '' + + pretty + + ''); + } };