docs for v0.3.50 after PR #227 and #222

yui · Apr 22, 2014 · 729888e · 729888e
1 parent 21e816d
commit 729888e
Show file tree

Hide file tree

Showing 27 changed files with 179 additions and 38 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.49)
+Current version (0.3.50)
 
 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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -289,6 +289,13 @@ <h3>Methods</h3>
 
 
 
+                            </li>
+
+                            <li class="index-item method private">
+                                <a href="#method_runPreprocessors">runPreprocessors</a>
+
+
+
                             </li>
 
                             <li class="index-item method private">
@@ -739,7 +746,7 @@ <h3 class="name"><code>run</code></h3>
 
 
 
-        <a href="../files/lib_yuidoc.js.html#l334"><code>lib&#x2F;yuidoc.js:334</code></a>
+        <a href="../files/lib_yuidoc.js.html#l376"><code>lib&#x2F;yuidoc.js:376</code></a>
 
         </p>
 
@@ -773,6 +780,82 @@ <h4>Returns:</h4>
 
 
 
+</div>
+
+
+                    <div id="method_runPreprocessors" class="method item private">
+    <h3 class="name"><code>runPreprocessors</code></h3>
+
+
+        <span class="paren">()</span>
+
+
+
+        <span class="returns-inline">
+            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
+        </span>
+
+
+
+
+
+        <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+    <div class="meta">
+
+
+
+                <p>
+
+                Defined in
+
+
+
+
+        <a href="../files/lib_yuidoc.js.html#l248"><code>lib&#x2F;yuidoc.js:248</code></a>
+
+        </p>
+
+
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Applies preprocessors to the data tree. 
+This function first clones the data and operates on the clone.</p>
+
+    </div>
+
+
+
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+
+
+                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
+
+                    <p>The mutated data</p>
+
+
+            </div>
+        </div>
+
+
+
 </div>
 
 
@@ -881,7 +964,7 @@ <h3 class="name"><code>writeJSON</code></h3>
 
 
 
-        <a href="../files/lib_yuidoc.js.html#l248"><code>lib&#x2F;yuidoc.js:248</code></a>
+        <a href="../files/lib_yuidoc.js.html#l287"><code>lib&#x2F;yuidoc.js:287</code></a>
 
         </p>
 
@@ -892,7 +975,8 @@ <h3 class="name"><code>writeJSON</code></h3>
     </div>
 
     <div class="description">
-        <p>Writes the parser JSON data to disk.</p>
+        <p>Writes the parser JSON data to disk.
+Applies preprocessors, if any.</p>
 
     </div>
 
@@ -1020,7 +1104,7 @@ <h3 class="name"><code>endtime</code></h3>
 
 
 
-        <a href="../files/lib_yuidoc.js.html#l362"><code>lib&#x2F;yuidoc.js:362</code></a>
+        <a href="../files/lib_yuidoc.js.html#l404"><code>lib&#x2F;yuidoc.js:404</code></a>
 
         </p>
 
@@ -1300,7 +1384,7 @@ <h3 class="name"><code>starttime</code></h3>
 
 
 
-        <a href="../files/lib_yuidoc.js.html#l340"><code>lib&#x2F;yuidoc.js:340</code></a>
+        <a href="../files/lib_yuidoc.js.html#l382"><code>lib&#x2F;yuidoc.js:382</code></a>
 
         </p>
 

diff --git a/output/api/data.json b/output/api/data.json
@@ -3,7 +3,7 @@
         "name": "yuidoc-root",
         "logo": "http://yuilibrary.com/img/yui-logo.png",
         "description": "YUIDoc, YUI's JavaScript Documentation engine.",
-        "version": "0.3.49"
+        "version": "0.3.50"
     },
     "files": {
         "lib/builder.js": {
@@ -2349,7 +2349,22 @@
         {
             "file": "lib/yuidoc.js",
             "line": 248,
-            "description": "Writes the parser JSON data to disk.",
+            "description": "Applies preprocessors to the data tree. \nThis function first clones the data and operates on the clone.",
+            "itemtype": "method",
+            "name": "runPreprocessors",
+            "access": "private",
+            "tagname": "",
+            "return": {
+                "description": "The mutated data",
+                "type": "Object"
+            },
+            "class": "YUIDoc",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/yuidoc.js",
+            "line": 287,
+            "description": "Writes the parser JSON data to disk.\nApplies preprocessors, if any.",
             "itemtype": "method",
             "name": "writeJSON",
             "params": [
@@ -2370,7 +2385,7 @@
         },
         {
             "file": "lib/yuidoc.js",
-            "line": 334,
+            "line": 376,
             "description": "Process the config, walk the file tree and write out the JSON data.",
             "itemtype": "method",
             "name": "run",
@@ -2383,7 +2398,7 @@
         },
         {
             "file": "lib/yuidoc.js",
-            "line": 340,
+            "line": 382,
             "description": "Timestamp holder so we know when YUIDoc started the parse process.",
             "itemtype": "property",
             "name": "starttime",
@@ -2393,7 +2408,7 @@
         },
         {
             "file": "lib/yuidoc.js",
-            "line": 362,
+            "line": 404,
             "description": "Timestamp holder so we know when YUIDoc has finished the parse process.",
             "itemtype": "property",
             "name": "endtime",

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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -370,7 +370,7 @@ <h1 class="file-heading">File: lib/docparser.js</h1>
                 // extract the first word, this is the param name
                 match = REGEX_FIRSTWORD.exec(desc);
                 if (match) {
-                    name = trim(match[1]);
+                    name = trim(explodeString(match[1]));
                     desc = trim(match[2]);
                 }
 
@@ -493,7 +493,7 @@ <h1 class="file-heading">File: lib/docparser.js</h1>
                 }
 
                 result = {
-                    description: explodeString(desc)
+                    description: Y.unindent(explodeString(desc))
                 };
 
                 if (type) {

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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</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://yuilibrary.com/img/yui-logo.png" title="yuidoc-root"></h1>
 
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 0.3.49</em>
+            <em>API Docs for: 0.3.50</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">