Docs update

node-migrator-bot · Jul 6, 2012 · 5e7e7ff · 5e7e7ff
1 parent be76bcd
commit 5e7e7ff
Show file tree

Hide file tree

Showing 31 changed files with 77 additions and 83 deletions.
diff --git a/conf/docs/project.json b/conf/docs/project.json
@@ -1,5 +1,5 @@
 {
   "projectName": "YUIDoc - Javascript Documentation Tool",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "yuiSeedUrl": "http://yui.yahooapis.com/3.5.1/build/yui/yui.js"
 }
diff --git a/conf/yuidoc.json b/conf/yuidoc.json
@@ -1,7 +1,7 @@
 {
   "name": "YUIDoc",
   "description": "YUIDoc documentation tool written in Javascript",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "url": "http://github.com/yui/yuidoc/issues",
   "logo": "http://yuilibrary.com/img/yui-logo.png",
   "options": {

diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache
@@ -1,7 +1,7 @@
 
 YUI Doc generates API documentation from a modified JavaDoc syntax.
 
-Current version (0.3.14)
+Current version (0.3.15)
 
 Usage: yuidoc <options> <input path>
 

diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -398,7 +398,7 @@ <h3 class="name"><code>fixType</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l364"><code>lib&#x2F;utils.js:364</code></a>
+        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l368"><code>lib&#x2F;utils.js:368</code></a>
 
         </p>
 
@@ -502,7 +502,7 @@ <h3 class="name"><code>getDirs</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l268"><code>lib&#x2F;utils.js:268</code></a>
+        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l272"><code>lib&#x2F;utils.js:272</code></a>
 
         </p>
 
@@ -1384,7 +1384,7 @@ <h3 class="name"><code>validatePaths</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l295"><code>lib&#x2F;utils.js:295</code></a>
+        <a href="..&#x2F;files&#x2F;lib_utils.js.html#l299"><code>lib&#x2F;utils.js:299</code></a>
 
         </p>
 

diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/data.json b/output/api/data.json
@@ -2,7 +2,7 @@
     "project": {
         "name": "YUIDoc",
         "description": "YUIDoc documentation tool written in Javascript",
-        "version": "0.3.14",
+        "version": "0.3.15",
         "url": "http://github.com/yui/yuidoc/issues",
         "logo": "http://yuilibrary.com/img/yui-logo.png"
     },
@@ -2074,7 +2074,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 268,
+            "line": 272,
             "description": "Walks the tree from this dir and returns all the subdirs",
             "itemtype": "method",
             "name": "getDirs",
@@ -2094,7 +2094,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 295,
+            "line": 299,
             "description": "Make sure all the paths passed are directories and that they are not in the ignore list.",
             "itemtype": "method",
             "name": "validatePaths",
@@ -2117,7 +2117,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 364,
+            "line": 368,
             "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",

diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -345,10 +345,14 @@ <h1 class="file-heading">File: lib&#x2F;utils.js</h1>
     }
     var dirs = fs.readdirSync(dir);
     dirs.forEach(function(d) {
+        var p = path.join(dir, d);
         if (d.indexOf(&#x27;.&#x27;) === 0) {
             return;
         }
-        var p = path.join(dir, d);
+        if (d === &#x27;node_modules&#x27;) {
+            Y.log(&#x27;Skipping node_modules directory while scanning for yuidoc.json&#x27;, &#x27;warn&#x27;, &#x27;yuidoc&#x27;);
+            return;
+        }
         if (projectData) {
             return;
         }

diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/index.html b/output/api/index.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html
@@ -19,7 +19,7 @@ <h1><img src="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title=
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.14</em>
+            <em>API Docs for: 0.3.15</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

diff --git a/output/args/index.html b/output/args/index.html
@@ -45,7 +45,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.14)
+Current version (0.3.15)
 
 Usage: yuidoc &lt;options&gt; &lt;input path&gt;