Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davglass committed Mar 20, 2013
1 parent f3c23f6 commit 7ef0e41
Show file tree
Hide file tree
Showing 28 changed files with 157 additions and 132 deletions.
2 changes: 1 addition & 1 deletion docs/args/partials/help.mustache
@@ -1,7 +1,7 @@

YUI Doc generates API documentation from a modified JavaDoc syntax.

Current version (0.3.39)
Current version (0.3.40)

Usage: yuidoc <options> <input path>

Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/CLI.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>CLI - YUIDoc</title>
<title>CLI - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/DocBuilder.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocBuilder - YUIDoc</title>
<title>DocBuilder - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/DocParser.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocParser - YUIDoc</title>
<title>DocParser - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/DocView.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocView - YUIDoc</title>
<title>DocView - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/Files.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Files - YUIDoc</title>
<title>Files - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/Help.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Help - YUIDoc</title>
<title>Help - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/Main.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Main - YUIDoc</title>
<title>Main - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/Options.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Options - YUIDoc</title>
<title>Options - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/Server.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Server - YUIDoc</title>
<title>Server - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
14 changes: 7 additions & 7 deletions output/api/classes/Utils.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Utils - YUIDoc</title>
<title>Utils - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down Expand Up @@ -398,7 +398,7 @@ <h3 class="name"><code>fixType</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l407"><code>lib&#x2F;utils.js:407</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l432"><code>lib&#x2F;utils.js:432</code></a>

</p>

Expand Down Expand Up @@ -502,7 +502,7 @@ <h3 class="name"><code>getDirs</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l311"><code>lib&#x2F;utils.js:311</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l336"><code>lib&#x2F;utils.js:336</code></a>

</p>

Expand Down Expand Up @@ -1022,7 +1022,7 @@ <h3 class="name"><code>getProjectData</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l225"><code>lib&#x2F;utils.js:225</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l223"><code>lib&#x2F;utils.js:223</code></a>

</p>

Expand Down Expand Up @@ -1384,7 +1384,7 @@ <h3 class="name"><code>validatePaths</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l338"><code>lib&#x2F;utils.js:338</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l363"><code>lib&#x2F;utils.js:363</code></a>

</p>

Expand Down
6 changes: 3 additions & 3 deletions output/api/classes/YUIDoc.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>YUIDoc - YUIDoc</title>
<title>YUIDoc - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
12 changes: 6 additions & 6 deletions output/api/data.json
@@ -1,9 +1,9 @@
{
"project": {
"name": "YUIDoc",
"name": "yuidoc-root",
"logo": "http://yuilibrary.com/img/yui-logo.png",
"description": "YUIDoc, YUI's JavaScript Documentation engine.",
"version": "0.3.39"
"version": "0.3.40"
},
"files": {
"lib/builder.js": {
Expand Down Expand Up @@ -2082,7 +2082,7 @@
},
{
"file": "lib/utils.js",
"line": 225,
"line": 223,
"description": "Walk the directory tree to locate the yuidoc.json file.",
"itemtype": "method",
"name": "getProjectData",
Expand All @@ -2100,7 +2100,7 @@
},
{
"file": "lib/utils.js",
"line": 311,
"line": 336,
"description": "Walks the tree from this dir and returns all the subdirs",
"itemtype": "method",
"name": "getDirs",
Expand All @@ -2120,7 +2120,7 @@
},
{
"file": "lib/utils.js",
"line": 338,
"line": 363,
"description": "Make sure all the paths passed are directories and that they are not in the ignore list.",
"itemtype": "method",
"name": "validatePaths",
Expand All @@ -2143,7 +2143,7 @@
},
{
"file": "lib/utils.js",
"line": 407,
"line": 432,
"description": "Takes a type string and converts it to a \"First letter upper cased\" type. e.g. `(string -> String, object -> Object)`",
"itemtype": "method",
"name": "fixType",
Expand Down
6 changes: 3 additions & 3 deletions output/api/files/lib_builder.js.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>lib&#x2F;builder.js - YUIDoc</title>
<title>lib&#x2F;builder.js - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions output/api/files/lib_cli.js.html
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>lib&#x2F;cli.js - YUIDoc</title>
<title>lib&#x2F;cli.js - yuidoc-root</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
Expand All @@ -15,11 +15,11 @@
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">

<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="yuidoc-root"></h1>

</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.39</em>
<em>API Docs for: 0.3.40</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down

0 comments on commit 7ef0e41

Please sign in to comment.