X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=build%2Fdocs.js;fp=build%2Fdocs.js;h=4ed6cc79c91af77eb46daa3f65aaca9933e2015b;hb=7d4bf9725472b7684533a35e5fbd143c28a5758c;hp=0000000000000000000000000000000000000000;hpb=991390e2422d558cac2cfa5508fe3e921ac38e42;p=jquery.git diff --git a/build/docs.js b/build/docs.js new file mode 100644 index 0000000..4ed6cc7 --- /dev/null +++ b/build/docs.js @@ -0,0 +1,98 @@ +load("build/js/json.js"); +load("build/js/xml.js"); +load("build/js/writeFile.js"); + +var types = { + jQuery: "A jQuery object.", + Object: "A simple Javascript object. For example, it could be a String or a Number.", + String: "A string of characters.", + Number: "A numeric valid.", + Element: "The Javascript object representation of a DOM Element.", + Hash: "A Javascript object that contains key/value pairs in the form of properties and values.", + "Array<Element>": "An Array of DOM Elements.", + "Array<String>": "An Array of strings.", + Function: "A reference to a Javascript function." +}; + +var f = readFile("../jquery-svn.js"); + +var c = [], bm, m; +var blockMatch = /\/\*\*\s*((.|\n)*?)\s*\*\//g; +var paramMatch = /\@(\S+) *((.|\n)*?)(?=\n\@|!!!)/m; + +while ( bm = blockMatch.exec(f) ) { + block = bm[1].replace(/^\s*\* ?/mg,"") + "!!!"; + var ret = { params: [], examples: [] }; + + while ( m = paramMatch.exec( block ) ) { + block = block.replace( paramMatch, "" ); + + var n = m[1]; + var v = m[2] + .replace(/\s*$/g,"") + .replace(/^\s*/g,"") + .replace(/&/g, "&") + .replace(//g, ">") + .replace(/\n/g, "
") + /*.replace(/(\s\s+)/g, function(a){ + var ret = ""; + for ( var i = 0; i < a.length; i++ ) + ret += " "; + return ret; + })*/ || 1; + + if ( n == 'param' || n == 'any' ) { + var args = v.split(/\s+/); + v = args.slice( 2, args.length ); + v = { type: args[0], name: args[1], desc: v.join(' ') }; + if ( n == 'any' ) v.any = 1; + n = "params"; + } else if ( n == 'example' ) { + v = { code: v }; + n = "examples"; + } + + if ( n == 'desc' || n == 'before' || n == 'after' || n == 'result' ) { + ret.examples[ ret.examples.length - 1 ][ n ] = v; + } else { + if ( ret[ n ] ) { + if ( ret[ n ].constructor == Array ) { + ret[ n ].push( v ); + } else { + ret[ n ] = [ ret[ n ], v ]; + } + } else { + ret[ n ] = v; + } + } + } + + ret.desc = block.replace(/\s*!!!$/,"") + .replace(//g, ">"); + //.replace(/\n\n/g, "

") + //.replace(/\n/g, " "); + + var m = /^((.|\n)*?(\.|$))/.exec( ret.desc ); + if ( m ) ret['short'] = m[1]; + + if ( ret.name ) c.push( ret ); +} + +var json = Object.toJSON( c ); + +writeFile( "data/jquery-docs-json.js", json ); +writeFile( "data/jquery-docs-jsonp.js", "docsLoaded(" + json + ")" ); + +Object.toXML.force = { desc: 1, code: 1, before: 1, result: 1 }; + +var xml = Object.toXML( { method: c }, "docs" ); + +writeFile( "data/jquery-docs-xml.xml", + "\n" + xml ); + +writeFile( "index.xml", + "\n" + + "\n" + xml +);