Docs

colorpeach · Nov 6, 2012 · 24eb0ed · 24eb0ed
1 parent a5094d0
commit 24eb0ed
Show file tree

Hide file tree

Showing 30 changed files with 441 additions and 386 deletions.
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.30)
+Current version (0.3.31)
 
 Usage: yuidoc <options> <input path>
 
@@ -31,6 +31,7 @@ Common Options:
   -T, --theme <simple|default> Choose one of the built in themes (default is default)
   --syntaxtype <js|coffee> Choose comment syntax type (default is js)
   --server <port> Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)
+  --lint Lint your docs, will print parser warnings and exit code 1 if there are any
 
   <input path> Supply a list of paths (shell globbing is handy here)
 
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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -116,7 +116,7 @@ <h1>DocParser Class</h1>
 
 
         <div class="foundat">
-            Defined in: <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l710"><code>lib&#x2F;docparser.js:710</code></a>
+            Defined in: <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l722"><code>lib&#x2F;docparser.js:722</code></a>
         </div>
 
 
@@ -182,7 +182,7 @@ <h3 class="name"><code>DocParser</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l710"><code>lib&#x2F;docparser.js:710</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l722"><code>lib&#x2F;docparser.js:722</code></a>
 
         </p>
 
@@ -4135,7 +4135,7 @@ <h3 class="name"><code>_resolveFor</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l975"><code>lib&#x2F;docparser.js:975</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l991"><code>lib&#x2F;docparser.js:991</code></a>
 
         </p>
 
@@ -6171,7 +6171,7 @@ <h3 class="name"><code>extract</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1139"><code>lib&#x2F;docparser.js:1139</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1157"><code>lib&#x2F;docparser.js:1157</code></a>
 
         </p>
 
@@ -6840,7 +6840,7 @@ <h3 class="name"><code>handlecomment</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1068"><code>lib&#x2F;docparser.js:1068</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1086"><code>lib&#x2F;docparser.js:1086</code></a>
 
         </p>
 
@@ -7715,7 +7715,7 @@ <h3 class="name"><code>parse</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1370"><code>lib&#x2F;docparser.js:1370</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1398"><code>lib&#x2F;docparser.js:1398</code></a>
 
         </p>
 
@@ -7964,7 +7964,7 @@ <h3 class="name"><code>processblock</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1193"><code>lib&#x2F;docparser.js:1193</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1211"><code>lib&#x2F;docparser.js:1211</code></a>
 
         </p>
 
@@ -8970,7 +8970,7 @@ <h3 class="name"><code>transform</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1261"><code>lib&#x2F;docparser.js:1261</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1285"><code>lib&#x2F;docparser.js:1285</code></a>
 
         </p>
 
@@ -9078,7 +9078,7 @@ <h3 class="name"><code>unindent</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1046"><code>lib&#x2F;docparser.js:1046</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l1064"><code>lib&#x2F;docparser.js:1064</code></a>
 
         </p>
 
@@ -9568,7 +9568,7 @@ <h3 class="name"><code>currentclass</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l939"><code>lib&#x2F;docparser.js:939</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l955"><code>lib&#x2F;docparser.js:955</code></a>
 
         </p>
 
@@ -9670,7 +9670,7 @@ <h3 class="name"><code>currentfile</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l790"><code>lib&#x2F;docparser.js:790</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l806"><code>lib&#x2F;docparser.js:806</code></a>
 
         </p>
 
@@ -9772,7 +9772,7 @@ <h3 class="name"><code>currentmodule</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l847"><code>lib&#x2F;docparser.js:847</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l863"><code>lib&#x2F;docparser.js:863</code></a>
 
         </p>
 
@@ -9874,7 +9874,7 @@ <h3 class="name"><code>currentsubmodule</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l899"><code>lib&#x2F;docparser.js:899</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l915"><code>lib&#x2F;docparser.js:915</code></a>
 
         </p>
 
@@ -10080,7 +10080,7 @@ <h3 class="name"><code>digesters</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l730"><code>lib&#x2F;docparser.js:730</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l746"><code>lib&#x2F;docparser.js:746</code></a>
 
         </p>
 
@@ -10192,7 +10192,7 @@ <h3 class="name"><code>dirmap</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l780"><code>lib&#x2F;docparser.js:780</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l796"><code>lib&#x2F;docparser.js:796</code></a>
 
         </p>
 
@@ -10296,7 +10296,7 @@ <h3 class="name"><code>emitters</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l752"><code>lib&#x2F;docparser.js:752</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l768"><code>lib&#x2F;docparser.js:768</code></a>
 
         </p>
 
@@ -10399,7 +10399,7 @@ <h3 class="name"><code>filemap</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l772"><code>lib&#x2F;docparser.js:772</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l788"><code>lib&#x2F;docparser.js:788</code></a>
 
         </p>
 
@@ -10605,7 +10605,7 @@ <h3 class="name"><code>mainmodule</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l811"><code>lib&#x2F;docparser.js:811</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l827"><code>lib&#x2F;docparser.js:827</code></a>
 
         </p>
 
@@ -10707,7 +10707,7 @@ <h3 class="name"><code>syntaxtype</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l763"><code>lib&#x2F;docparser.js:763</code></a>
+        <a href="..&#x2F;files&#x2F;lib_docparser.js.html#l779"><code>lib&#x2F;docparser.js:779</code></a>
 
         </p>
 

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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -238,7 +238,7 @@ <h3 class="name"><code>renderHelp</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_help.js.html#l59"><code>lib&#x2F;help.js:59</code></a>
+        <a href="..&#x2F;files&#x2F;lib_help.js.html#l60"><code>lib&#x2F;help.js:60</code></a>
 
         </p>
 
@@ -305,7 +305,7 @@ <h3 class="name"><code>showHelp</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_help.js.html#l69"><code>lib&#x2F;help.js:69</code></a>
+        <a href="..&#x2F;files&#x2F;lib_help.js.html#l70"><code>lib&#x2F;help.js:70</code></a>
 
         </p>
 

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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</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.30</em>
+            <em>API Docs for: 0.3.31</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

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.30</em>
+            <em>API Docs for: 0.3.31</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -732,7 +732,7 @@ <h3 class="name"><code>run</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l295"><code>lib&#x2F;yuidoc.js:295</code></a>
+        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l311"><code>lib&#x2F;yuidoc.js:311</code></a>
 
         </p>
 
@@ -1006,7 +1006,7 @@ <h3 class="name"><code>endtime</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l320"><code>lib&#x2F;yuidoc.js:320</code></a>
+        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l340"><code>lib&#x2F;yuidoc.js:340</code></a>
 
         </p>
 
@@ -1280,7 +1280,7 @@ <h3 class="name"><code>starttime</code></h3>
 
 
 
-        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l301"><code>lib&#x2F;yuidoc.js:301</code></a>
+        <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l317"><code>lib&#x2F;yuidoc.js:317</code></a>
 
         </p>