Permalink
Browse files

Doc Updates

  • Loading branch information...
1 parent 7668a27 commit 34d9b628215169296ea50adee9003c7f962e9c32 @davglass committed May 10, 2012
View
@@ -1,27 +1,23 @@
YUI.add("yuidoc-meta", function(Y) {
Y.YUIDoc = { meta: {
"classes": [
+ "CLI",
"DocBuilder",
"DocParser",
"DocView",
"Files",
+ "Help",
+ "Index",
+ "Options",
"Server",
- "YUIDoc",
- "cli",
- "index",
- "utils"
+ "Utils",
+ "YUIDoc"
],
"modules": [
- "server",
"yuidoc"
],
"allModules": [
{
- "displayName": "server",
- "name": "server",
- "description": "Provides the `--server` server option for YUIDoc"
- },
- {
"displayName": "yuidoc",
"name": "yuidoc",
"description": "This is the __module__ description for the `YUIDoc` module.\n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidoc');\n var json = (new Y.YUIDoc(options)).run();"
@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>CLI - YUIDoc</title>
+ <link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.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">
+ <script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.0&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+ <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>
+
+ </div>
+ <div class="yui3-u-1-4 version">
+ <em>API Docs for: 0.3.2</em>
+ </div>
+ </div>
+ <div id="bd" class="yui3-g">
+
+ <div class="yui3-u-1-4">
+ <div id="docs-sidebar" class="sidebar apidocs">
+ <div id="api-list">
+ <h2 class="off-left">APIs</h2>
+ <div id="api-tabview" class="tabview">
+ <ul class="tabs">
+ <li><a href="#api-classes">Classes</a></li>
+ <li><a href="#api-modules">Modules</a></li>
+ </ul>
+
+ <div id="api-tabview-filter">
+ <input type="search" id="api-filter" placeholder="Type to filter APIs">
+ </div>
+
+ <div id="api-tabview-panel">
+ <ul id="api-classes" class="apis classes">
+
+ <li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
+
+ <li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
+
+ <li><a href="..&#x2F;classes/DocParser.html">DocParser</a></li>
+
+ <li><a href="..&#x2F;classes/DocView.html">DocView</a></li>
+
+ <li><a href="..&#x2F;classes/Files.html">Files</a></li>
+
+ <li><a href="..&#x2F;classes/Help.html">Help</a></li>
+
+ <li><a href="..&#x2F;classes/Index.html">Index</a></li>
+
+ <li><a href="..&#x2F;classes/Options.html">Options</a></li>
+
+ <li><a href="..&#x2F;classes/Server.html">Server</a></li>
+
+ <li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
+
+ <li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
+
+ </ul>
+
+ <ul id="api-modules" class="apis modules">
+
+ <li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <div class="yui3-u-3-4">
+ <div id="api-options">
+ Show:
+ <label for="api-show-inherited">
+ <input type="checkbox" id="api-show-inherited" checked>
+ Inherited
+ </label>
+
+ <label for="api-show-protected">
+ <input type="checkbox" id="api-show-protected">
+ Protected
+ </label>
+
+ <label for="api-show-private">
+ <input type="checkbox" id="api-show-private">
+ Private
+ </label>
+ </div>
+
+
+ <div class="apidocs">
+ <div id="docs-main">
+ <div class="content">
+ <h1>CLI Class</h1>
+<div class="box meta">
+
+
+
+
+
+ <div class="foundat">
+ Defined in: <a href="..&#x2F;files&#x2F;lib_cli.js.html#l8"><code>lib&#x2F;cli.js:8</code></a>
+ </div>
+
+
+
+
+ Module: <a href="../modules/yuidoc.html">yuidoc</a>
+
+
+
+
+</div>
+
+
+
+<div class="box intro">
+ <p>Parses the arguments, creates the options and passes them to <code>Y.YUIDoc</code> and then <code>Y.DocBuilder</code>.</p>
+</div>
+
+
+
+<div id="classdocs" class="tabview">
+ <ul class="api-class-tabs">
+ <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+
+
+
+
+ </ul>
+
+ <div>
+ <div id="index" class="api-class-tabpanel index">
+ <h2 class="off-left">Item Index</h2>
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+ </div>
+</div>
+
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="..&#x2F;assets/js/yui-prettify.js"></script>
+<script src="..&#x2F;assets/../api.js"></script>
+<script src="..&#x2F;assets/js/api-filter.js"></script>
+<script src="..&#x2F;assets/js/api-list.js"></script>
+<script src="..&#x2F;assets/js/api-search.js"></script>
+<script src="..&#x2F;assets/js/apidocs.js"></script>
+</body>
+</html>
@@ -40,7 +40,7 @@ <h2 class="off-left">APIs</h2>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
- <li><a href="..&#x2F;classes/cli.html">cli</a></li>
+ <li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
@@ -50,20 +50,22 @@ <h2 class="off-left">APIs</h2>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
- <li><a href="..&#x2F;classes/index.html">index</a></li>
+ <li><a href="..&#x2F;classes/Help.html">Help</a></li>
+
+ <li><a href="..&#x2F;classes/Index.html">Index</a></li>
+
+ <li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
- <li><a href="..&#x2F;classes/utils.html">utils</a></li>
+ <li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
- <li><a href="..&#x2F;modules/server.html">server</a></li>
-
<li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
</ul>
@@ -40,7 +40,7 @@ <h2 class="off-left">APIs</h2>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
- <li><a href="..&#x2F;classes/cli.html">cli</a></li>
+ <li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
@@ -50,20 +50,22 @@ <h2 class="off-left">APIs</h2>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
- <li><a href="..&#x2F;classes/index.html">index</a></li>
+ <li><a href="..&#x2F;classes/Help.html">Help</a></li>
+
+ <li><a href="..&#x2F;classes/Index.html">Index</a></li>
+
+ <li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
- <li><a href="..&#x2F;classes/utils.html">utils</a></li>
+ <li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
- <li><a href="..&#x2F;modules/server.html">server</a></li>
-
<li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
</ul>
@@ -40,7 +40,7 @@ <h2 class="off-left">APIs</h2>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
- <li><a href="..&#x2F;classes/cli.html">cli</a></li>
+ <li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
@@ -50,20 +50,22 @@ <h2 class="off-left">APIs</h2>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
- <li><a href="..&#x2F;classes/index.html">index</a></li>
+ <li><a href="..&#x2F;classes/Help.html">Help</a></li>
+
+ <li><a href="..&#x2F;classes/Index.html">Index</a></li>
+
+ <li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
- <li><a href="..&#x2F;classes/utils.html">utils</a></li>
+ <li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
- <li><a href="..&#x2F;modules/server.html">server</a></li>
-
<li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
</ul>
@@ -40,7 +40,7 @@ <h2 class="off-left">APIs</h2>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
- <li><a href="..&#x2F;classes/cli.html">cli</a></li>
+ <li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
@@ -50,20 +50,22 @@ <h2 class="off-left">APIs</h2>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
- <li><a href="..&#x2F;classes/index.html">index</a></li>
+ <li><a href="..&#x2F;classes/Help.html">Help</a></li>
+
+ <li><a href="..&#x2F;classes/Index.html">Index</a></li>
+
+ <li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
- <li><a href="..&#x2F;classes/utils.html">utils</a></li>
+ <li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
- <li><a href="..&#x2F;modules/server.html">server</a></li>
-
<li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
</ul>
Oops, something went wrong. Retry.

0 comments on commit 34d9b62

Please sign in to comment.