Permalink
Browse files

Doc updates

  • Loading branch information...
1 parent 7da044b commit 51f1ff1a6a7f18b1379f4633d39445e60a07a34e @davglass davglass committed May 17, 2012
@@ -1,7 +1,7 @@
YUI Doc generates API documentation from a modified JavaDoc syntax.
-Current version (0.3.7)
+Current version (0.3.8)
Usage: yuidoc <options> <input path>
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -1153,7 +1153,7 @@ <h3 class="name"><code>compile</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1459"><code>lib&#x2F;builder.js:1459</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1482"><code>lib&#x2F;builder.js:1482</code></a>
</p>
@@ -1244,7 +1244,7 @@ <h3 class="name"><code>filterFileName</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1446"><code>lib&#x2F;builder.js:1446</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1469"><code>lib&#x2F;builder.js:1469</code></a>
</p>
@@ -1428,7 +1428,7 @@ <h3 class="name"><code>hasProperty</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l927"><code>lib&#x2F;builder.js:927</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l939"><code>lib&#x2F;builder.js:939</code></a>
</p>
@@ -1782,7 +1782,7 @@ <h3 class="name"><code>mergeExtends</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l944"><code>lib&#x2F;builder.js:944</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l956"><code>lib&#x2F;builder.js:956</code></a>
</p>
@@ -1983,7 +1983,7 @@ <h3 class="name"><code>nameSort</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1294"><code>lib&#x2F;builder.js:1294</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1317"><code>lib&#x2F;builder.js:1317</code></a>
</p>
@@ -2722,7 +2722,7 @@ <h3 class="name"><code>renderAPIMeta</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1416"><code>lib&#x2F;builder.js:1416</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1439"><code>lib&#x2F;builder.js:1439</code></a>
</p>
@@ -2815,7 +2815,7 @@ <h3 class="name"><code>renderClass</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l989"><code>lib&#x2F;builder.js:989</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1001"><code>lib&#x2F;builder.js:1001</code></a>
</p>
@@ -2940,7 +2940,7 @@ <h3 class="name"><code>renderFile</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1355"><code>lib&#x2F;builder.js:1355</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1378"><code>lib&#x2F;builder.js:1378</code></a>
</p>
@@ -3311,7 +3311,7 @@ <h3 class="name"><code>writeAPIMeta</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1403"><code>lib&#x2F;builder.js:1403</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1426"><code>lib&#x2F;builder.js:1426</code></a>
</p>
@@ -3398,7 +3398,7 @@ <h3 class="name"><code>writeClasses</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1259"><code>lib&#x2F;builder.js:1259</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1282"><code>lib&#x2F;builder.js:1282</code></a>
</p>
@@ -3485,7 +3485,7 @@ <h3 class="name"><code>writeFiles</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1317"><code>lib&#x2F;builder.js:1317</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1340"><code>lib&#x2F;builder.js:1340</code></a>
</p>
@@ -3659,7 +3659,7 @@ <h3 class="name"><code>writeModules</code></h3>
- <a href="..&#x2F;files&#x2F;lib_builder.js.html#l892"><code>lib&#x2F;builder.js:892</code></a>
+ <a href="..&#x2F;files&#x2F;lib_builder.js.html#l904"><code>lib&#x2F;builder.js:904</code></a>
</p>
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
View
@@ -2,7 +2,7 @@
"project": {
"name": "YUIDoc",
"description": "YUIDoc documentation tool written in Javascript",
- "version": "0.3.7",
+ "version": "0.3.8",
"url": "http://github.com/yui/yuidoc/issues",
"logo": "http://yuilibrary.com/img/yui-logo.png"
},
@@ -806,7 +806,7 @@
},
{
"file": "lib/builder.js",
- "line": 892,
+ "line": 904,
"description": "Generates the module files under \"out\"/modules/",
"itemtype": "method",
"name": "writeModules",
@@ -822,7 +822,7 @@
},
{
"file": "lib/builder.js",
- "line": 927,
+ "line": 939,
"description": "Checks an array of items (class items) to see if an item is in that list",
"itemtype": "method",
"name": "hasProperty",
@@ -846,7 +846,7 @@
},
{
"file": "lib/builder.js",
- "line": 944,
+ "line": 956,
"description": "Merge superclass data into a child class",
"itemtype": "method",
"name": "mergeExtends",
@@ -867,7 +867,7 @@
},
{
"file": "lib/builder.js",
- "line": 989,
+ "line": 1001,
"description": "Render the class file",
"itemtype": "method",
"name": "renderClass",
@@ -895,7 +895,7 @@
},
{
"file": "lib/builder.js",
- "line": 1259,
+ "line": 1282,
"description": "Generates the class files under \"out\"/classes/",
"itemtype": "method",
"name": "writeClasses",
@@ -911,7 +911,7 @@
},
{
"file": "lib/builder.js",
- "line": 1294,
+ "line": 1317,
"description": "Sort method of array of objects with a property called __name__",
"itemtype": "method",
"name": "nameSort",
@@ -936,7 +936,7 @@
},
{
"file": "lib/builder.js",
- "line": 1317,
+ "line": 1340,
"description": "Generates the syntax files under `\"out\"/files/`",
"itemtype": "method",
"name": "writeFiles",
@@ -952,7 +952,7 @@
},
{
"file": "lib/builder.js",
- "line": 1355,
+ "line": 1378,
"description": "Render the source file",
"itemtype": "method",
"name": "renderFile",
@@ -980,7 +980,7 @@
},
{
"file": "lib/builder.js",
- "line": 1403,
+ "line": 1426,
"description": "Write the API meta data used for the AutoComplete widget",
"itemtype": "method",
"name": "writeAPIMeta",
@@ -997,7 +997,7 @@
},
{
"file": "lib/builder.js",
- "line": 1416,
+ "line": 1439,
"description": "Render the API meta and return the Javascript",
"itemtype": "method",
"name": "renderAPIMeta",
@@ -1014,7 +1014,7 @@
},
{
"file": "lib/builder.js",
- "line": 1446,
+ "line": 1469,
"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",
@@ -1034,7 +1034,7 @@
},
{
"file": "lib/builder.js",
- "line": 1459,
+ "line": 1482,
"description": "Compiles the templates from the meta-data provided by DocParser",
"itemtype": "method",
"name": "compile",
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -974,6 +974,18 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
});
opts.meta.moduleClasses.sort(self.nameSort);
}
+ if (data.example &amp;&amp; data.example.length) {
+ if (data.example.forEach) {
+ var e = &#x27;&#x27;;
+ data.example.forEach(function(v) {
+ e += self._parseCode(self.markdown(v));
+ });
+ data.example = e;
+ } else {
+ data.example = self._parseCode(self.markdown(i.example));
+ }
+ opts.meta.example = data.example;
+ }
if (data.submodules &amp;&amp; Object.keys(data.submodules).length) {
opts.meta.subModules = [];
Y.each(Object.keys(data.submodules), function(name) {
@@ -1181,6 +1193,17 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
}
&#x2F;&#x2F;console.error(i);
opts.meta.is_constructor = [i];
+ if (i.example &amp;&amp; i.example.length) {
+ if (i.example.forEach) {
+ var e = &#x27;&#x27;;
+ i.example.forEach(function(v) {
+ e += self._parseCode(self.markdown(v));
+ });
+ i.example = e;
+ } else {
+ i.example = self._parseCode(self.markdown(i.example));
+ }
+ }
}
classItems.forEach(function(i) {
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -19,7 +19,7 @@
</div>
<div class="yui3-u-1-4 version">
- <em>API Docs for: 0.3.7</em>
+ <em>API Docs for: 0.3.8</em>
</div>
</div>
<div id="bd" class="yui3-g">
Oops, something went wrong.

0 comments on commit 51f1ff1

Please sign in to comment.