deac/jquery
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Massive overhauls to the test suite - it is now generated dynamically, along with the documentation.

Browse source
This commit is contained in:
John Resig 2006-08-14 01:46:05 +00:00
parent 61aab47bcf
commit 7448c61ee2
10 changed files with 467 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

81
build/docs/docs.js
View file

@ -1,83 +1,6 @@
load("build/js/json.js", "build/js/xml.js", "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(arguments[0]);
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, "&lt;")
.replace(/>/g, "&gt;")
.replace(/\n/g, "<br/>")
/*.replace(/(\s\s+)/g, function(a){
var ret = "";
for ( var i = 0; i < a.length; i++ )
ret += "&nbsp;";
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, "&lt;")
.replace(/>/g, "&gt;");
//.replace(/\n\n/g, "<br/><br/>")
//.replace(/\n/g, " ");
var m = /^((.|\n)*?(\.|$))/.exec( ret.desc );
if ( m ) ret['short'] = m[1];
if ( ret.name ) c.push( ret );
}
load("build/js/json.js", "build/js/xml.js", "build/js/writeFile.js", "build/js/parse.js");
var c = parse( readFile(arguments[0]) );
var json = Object.toJSON( c );
writeFile( arguments[1] + "/data/jquery-docs-json.js", json );

5
build/docs/js/doc.js
View file

@ -11,7 +11,10 @@ var types = {
};
$(document).ready(function(){
$("span.tooltip").ToolTipDemo('#fff');
$("span.tooltip").each(function(){
if ( types[ this.innerHTML ] )
this.title = types[ this.innerHTML ];
}).ToolTipDemo('#fff');
$("a.name").click(function(){
$("div.more,div.short",this.parentNode.parentNode).toggle().find("div.desc",function(){

10
build/docs/style/docs.xsl
View file

@ -6,7 +6,7 @@
<head>
<title>jQuery Docs - API</title>
<link rel="stylesheet" href="style/style.css"/>
<script src="../dist/jquery-svn.js"></script>
<script src="../dist/jquery.js"></script>
<script src="js/tooltip.js"></script>
<script src="js/pager.js"></script>
<script src="js/doc.js"></script>
@ -18,13 +18,13 @@
<xsl:sort select="@name"/>
<xsl:sort select="count(params)"/>
<li>
<span class='type'><span title='TYPE' class='tooltip'><xsl:value-of select="@type"/></span></span>
<span class='type'><span class='tooltip'><xsl:value-of select="@type"/></span></span>
<span class='fn'>
<a href='#{@name}' class='name' title=''><xsl:value-of select="@name"/></a>
<xsl:if test="not(@property)">(
<xsl:for-each select="params">
<span class='arg-type tooltip' title='TYPE'><xsl:value-of select="@type"/></span><xsl:text> </xsl:text>
<span class='arg-name tooltip' title='{@desc}'><xsl:value-of select="@name"/></span>
<span class='arg-type tooltip'><xsl:value-of select="@type"/></span><xsl:text> </xsl:text>
<span class='arg-name tooltip' title='{desc}'><xsl:value-of select="@name"/></span>
<xsl:if test="position() != last()">
<xsl:if test="@any"> or </xsl:if>
<xsl:if test="not(@any)">, </xsl:if>
@ -60,6 +60,8 @@
</li>
</xsl:for-each>
</ul>
<p class="raw"><b>Raw Data:</b><xsl:text> </xsl:text><a href="data/jquery-docs-json.js">JSON</a>, <a href="data/jquery-docs-jsonp.js">JSONP</a>, <a href="data/jquery-docs-xml.xml">XML</a></p>
</body>
</html>
</xsl:template>

12
build/docs/style/style.css
View file

@ -126,3 +126,15 @@ ul#docs li div.example pre {
padding: 5px;
overflow: auto;
}
p.raw {
font-size: 11px;
color: #FFF;
margin: 5px auto;
width: 600px;
text-align: right;
}
p.raw a {
color: #FFF;
}