Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Doc Update

  • Loading branch information...
commit c58a7f3296a42e6a276ca9acd3a1aed5f5a80aee 1 parent 88fcc4e
@davglass authored
Showing with 48 additions and 43 deletions.
  1. +1 −1  docs/args/partials/help.mustache
  2. +1 −1  output/api/classes/CLI.html
  3. +6 −6 output/api/classes/DocBuilder.html
  4. +1 −1  output/api/classes/DocParser.html
  5. +1 −1  output/api/classes/DocView.html
  6. +1 −1  output/api/classes/Files.html
  7. +1 −1  output/api/classes/Help.html
  8. +1 −1  output/api/classes/Index.html
  9. +1 −1  output/api/classes/Options.html
  10. +1 −1  output/api/classes/Server.html
  11. +1 −1  output/api/classes/Utils.html
  12. +1 −1  output/api/classes/YUIDoc.html
  13. +6 −6 output/api/data.json
  14. +5 −4 output/api/files/lib_builder.js.html
  15. +1 −1  output/api/files/lib_cli.js.html
  16. +1 −1  output/api/files/lib_docparser.js.html
  17. +1 −1  output/api/files/lib_docview.js.html
  18. +1 −1  output/api/files/lib_files.js.html
  19. +1 −1  output/api/files/lib_help.js.html
  20. +1 −1  output/api/files/lib_index.js.html
  21. +1 −1  output/api/files/lib_options.js.html
  22. +1 −1  output/api/files/lib_server.js.html
  23. +1 −1  output/api/files/lib_utils.js.html
  24. +1 −1  output/api/files/lib_yuidoc.js.html
  25. +1 −1  output/api/index.html
  26. +1 −1  output/api/modules/yuidoc.html
  27. +6 −2 output/args/index.html
  28. +2 −2 output/index.html
View
2  docs/args/partials/help.mustache
@@ -1,7 +1,7 @@
YUI Doc generates API documentation from a modified JavaDoc syntax.
-Current version (0.3.2)
+Current version (0.3.4)
Usage: yuidoc <options> <input path>
View
2  output/api/classes/CLI.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
12 output/api/classes/DocBuilder.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -654,7 +654,7 @@ <h3 class="name"><code>compile</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1310"><code>lib&#x2F;builder.js:1310</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1311"><code>lib&#x2F;builder.js:1311</code></a>
</p>
@@ -743,7 +743,7 @@ <h3 class="name"><code>filterFileName</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1297"><code>lib&#x2F;builder.js:1297</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1298"><code>lib&#x2F;builder.js:1298</code></a>
</p>
@@ -1258,7 +1258,7 @@ <h3 class="name"><code>nameSort</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1164"><code>lib&#x2F;builder.js:1164</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1165"><code>lib&#x2F;builder.js:1165</code></a>
</p>
@@ -2002,7 +2002,7 @@ <h3 class="name"><code>writeClasses</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1129"><code>lib&#x2F;builder.js:1129</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1130"><code>lib&#x2F;builder.js:1130</code></a>
</p>
@@ -2087,7 +2087,7 @@ <h3 class="name"><code>writeFiles</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1187"><code>lib&#x2F;builder.js:1187</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1188"><code>lib&#x2F;builder.js:1188</code></a>
</p>
View
2  output/api/classes/DocParser.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/DocView.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Files.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Help.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Index.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Options.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Server.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/Utils.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/classes/YUIDoc.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
12 output/api/data.json
@@ -2,7 +2,7 @@
"project": {
"name": "YUIDoc",
"description": "YUIDoc documentation tool written in Javascript",
- "version": "0.3.2",
+ "version": "0.3.4",
"url": "http://github.com/yui/yuidoc/issues",
"logo": "http://yuilibrary.com/img/yui-logo.png"
},
@@ -671,7 +671,7 @@
},
{
"file": "lib/builder.js",
- "line": 1129,
+ "line": 1130,
"description": "Generates the class files under \"out\"/classes/",
"itemtype": "method",
"name": "writeClasses",
@@ -687,7 +687,7 @@
},
{
"file": "lib/builder.js",
- "line": 1164,
+ "line": 1165,
"description": "Sort method of array of objects with a property called __name__",
"itemtype": "method",
"name": "nameSort",
@@ -712,7 +712,7 @@
},
{
"file": "lib/builder.js",
- "line": 1187,
+ "line": 1188,
"description": "Generates the syntax files under `\"out\"/files/`",
"itemtype": "method",
"name": "writeFiles",
@@ -728,7 +728,7 @@
},
{
"file": "lib/builder.js",
- "line": 1297,
+ "line": 1298,
"description": "Normalizes a file path to a writable filename:\n\n var path = 'lib/file.js';\n returns 'lib_file.js';",
"itemtype": "method",
"name": "filterFileName",
@@ -748,7 +748,7 @@
},
{
"file": "lib/builder.js",
- "line": 1310,
+ "line": 1311,
"description": "Compiles the templates from the meta-data provided by DocParser",
"itemtype": "method",
"name": "compile",
View
9 output/api/files/lib_builder.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -920,7 +920,7 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
});
},
hasProperty: function(a, b) {
- var other;
+ var other = false;
var h = Y.some(a, function(i, k) {
if ((i.itemtype === b.itemtype) &amp;&amp; (i.name === b.name)) {
other = k;
@@ -944,7 +944,7 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
if (hasItems[v.class]) {
if (!v.static) {
var override = self.hasProperty(classItems, v);
- if (!override) {
+ if (override === false) {
&#x2F;&#x2F;This method was extended from the parent class but not over written
&#x2F;&#x2F;console.error(&#x27;Merging extends from&#x27;, v.class, &#x27;onto&#x27;, info.name);
var q = Y.merge({}, v);
@@ -1223,11 +1223,12 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
self.files++;
stack.html = html;
stack.view = view;
+ stack.opts = opts;
}));
});
stack.done(function() {
- cb(stack.html, stack.view);
+ cb(stack.html, stack.view, stack.opts);
});
},
&#x2F;**
View
2  output/api/files/lib_cli.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_docparser.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_docview.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_files.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_help.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_index.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_options.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_server.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_utils.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/files/lib_yuidoc.js.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/index.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
2  output/api/modules/yuidoc.html
@@ -18,7 +18,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.2</em>
+ <em>API Docs for: 0.3.4</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
8 output/args/index.html
@@ -42,7 +42,7 @@ <h2 id="command-line">Running YUIDoc on the Command Line</h2>
<pre class="code terminal">YUI Doc generates API documentation from a modified JavaDoc syntax.
-Current version (0.3.2)
+Current version (0.3.4)
Usage: yuidoc &lt;options&gt; &lt;input path&gt;
@@ -258,7 +258,11 @@ <h4 id="yuidoc-options">YUIDoc Options</h4>
</tr>
<tr>
<td><code>ignorePaths</code></th>
- <td>Specifies an array of string paths to ignore when scanning the source tree.</td>
+ <td>Specifies an array of string paths to ignore when using shell globbing. This only removes top level items from the list to initally scan. Use <code>exclude</code> to remove specific directoies..</td>
+</tr>
+<tr>
+ <td><code>exclude</code></th>
+ <td>Specify a comma separated list of names you want to exclude from parses when YUIDoc recurses the source tree.</td>
</tr>
<tr>
<td><code>paths</code></th>
View
4 output/index.html
@@ -21,7 +21,7 @@
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
- <div class="content"><h2 id="welcome-to-yuidoc-032">Welcome to YUIDoc 0.3.2!</h2>
+ <div class="content"><h2 id="welcome-to-yuidoc-034">Welcome to YUIDoc 0.3.4!</h2>
<div class="intro">
<p>YUIDoc is a <a href="http://nodejs.org/">Node.js</a> application that
@@ -130,7 +130,7 @@ <h2 class="no-toc">Table of Contents</h2>
<div class="bd">
<ul class="toc">
<li>
-<a href="#welcome-to-yuidoc-032">Welcome to YUIDoc 0.3.2!</a>
+<a href="#welcome-to-yuidoc-034">Welcome to YUIDoc 0.3.4!</a>
</li>
<li>
<a href="##install">Installation and Usage</a>

0 comments on commit c58a7f3

Please sign in to comment.
Something went wrong with that request. Please try again.