Permalink
Browse files

Doc Updates

  • Loading branch information...
1 parent ba79f37 commit dcd0d6d897f8126c578049aea63e0b0736c1ec53 @davglass davglass committed Apr 12, 2012
@@ -25,6 +25,7 @@ Common Options:
-o, --out <directory path> Path to put the generated files (defaults to ./out)
-t, --themedir <directory path> Path to a custom theme directory containing Handlebars templates
-h, --help Show this help
+ -q, --quiet Supress logging output
-T, --theme <simple|default> Choose one of the built in themes (default is default)
--server <port> Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)
@@ -104,7 +104,7 @@ <h2 class="off-left">APIs</h2>
<div class="foundat">
- Defined in: <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l48"><code>lib&#x2F;yuidoc.js:48</code></a>
+ Defined in: <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l49"><code>lib&#x2F;yuidoc.js:49</code></a>
</div>
@@ -175,7 +175,7 @@ <h3 class="name"><code>YUIDoc</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l48"><code>lib&#x2F;yuidoc.js:48</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l49"><code>lib&#x2F;yuidoc.js:49</code></a>
</p>
@@ -386,7 +386,7 @@ <h3 class="name"><code>_processConfig</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l105"><code>lib&#x2F;yuidoc.js:105</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l112"><code>lib&#x2F;yuidoc.js:112</code></a>
</p>
@@ -450,7 +450,7 @@ <h3 class="name"><code>parsedir</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l124"><code>lib&#x2F;yuidoc.js:124</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l131"><code>lib&#x2F;yuidoc.js:131</code></a>
</p>
@@ -543,7 +543,7 @@ <h3 class="name"><code>parsefiles</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l155"><code>lib&#x2F;yuidoc.js:155</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l162"><code>lib&#x2F;yuidoc.js:162</code></a>
</p>
@@ -637,7 +637,7 @@ <h3 class="name"><code>run</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l266"><code>lib&#x2F;yuidoc.js:266</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l273"><code>lib&#x2F;yuidoc.js:273</code></a>
</p>
@@ -704,7 +704,7 @@ <h3 class="name"><code>walk</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l114"><code>lib&#x2F;yuidoc.js:114</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l121"><code>lib&#x2F;yuidoc.js:121</code></a>
</p>
@@ -772,7 +772,7 @@ <h3 class="name"><code>writeJSON</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l206"><code>lib&#x2F;yuidoc.js:206</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l213"><code>lib&#x2F;yuidoc.js:213</code></a>
</p>
@@ -863,7 +863,7 @@ <h3 class="name"><code>dirmap</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l86"><code>lib&#x2F;yuidoc.js:86</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l87"><code>lib&#x2F;yuidoc.js:87</code></a>
</p>
@@ -907,7 +907,7 @@ <h3 class="name"><code>endtime</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l290"><code>lib&#x2F;yuidoc.js:290</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l297"><code>lib&#x2F;yuidoc.js:297</code></a>
</p>
@@ -953,7 +953,7 @@ <h3 class="name"><code>filecount</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l65"><code>lib&#x2F;yuidoc.js:65</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l66"><code>lib&#x2F;yuidoc.js:66</code></a>
</p>
@@ -999,7 +999,7 @@ <h3 class="name"><code>filemap</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l79"><code>lib&#x2F;yuidoc.js:79</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l80"><code>lib&#x2F;yuidoc.js:80</code></a>
</p>
@@ -1091,7 +1091,7 @@ <h3 class="name"><code>options</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l94"><code>lib&#x2F;yuidoc.js:94</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l95"><code>lib&#x2F;yuidoc.js:95</code></a>
</p>
@@ -1137,7 +1137,7 @@ <h3 class="name"><code>selleck</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l72"><code>lib&#x2F;yuidoc.js:72</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l73"><code>lib&#x2F;yuidoc.js:73</code></a>
</p>
@@ -1181,7 +1181,7 @@ <h3 class="name"><code>starttime</code></h3>
- <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l272"><code>lib&#x2F;yuidoc.js:272</code></a>
+ <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l279"><code>lib&#x2F;yuidoc.js:279</code></a>
</p>
View
@@ -120,7 +120,7 @@
"namespaces": {},
"tag": "main",
"file": "lib/yuidoc.js",
- "line": 48,
+ "line": 49,
"description": "This is the __module__ description for the `YUIDoc` module.\n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidoc');\n var json = (new Y.YUIDoc(options)).run();",
"itemtype": "main"
},
@@ -284,7 +284,7 @@
"module": "yuidoc",
"namespace": "",
"file": "lib/yuidoc.js",
- "line": 48,
+ "line": 49,
"description": "YUIDoc main class\n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidoc');\n var json = (new Y.YUIDoc(options)).run();",
"mainName": "yuidoc",
"tag": "main",
@@ -1766,7 +1766,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 65,
+ "line": 66,
"description": "Holds the number of files that we are processing.",
"itemtype": "property",
"name": "filecount",
@@ -1778,7 +1778,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 72,
+ "line": 73,
"description": "Hash map of dirnames to selleck config options.",
"itemtype": "property",
"name": "selleck",
@@ -1790,7 +1790,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 79,
+ "line": 80,
"description": "Holder for the list of files we are processing.",
"itemtype": "property",
"name": "filemap",
@@ -1802,7 +1802,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 86,
+ "line": 87,
"description": "Holder for the list of directories we are processing.",
"itemtype": "property",
"name": "dirmap",
@@ -1814,7 +1814,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 94,
+ "line": 95,
"description": "Internal holder for configuration options.",
"itemtype": "property",
"name": "options",
@@ -1826,7 +1826,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 105,
+ "line": 112,
"description": "Does post process on self.options.",
"itemtype": "method",
"name": "_processConfig",
@@ -1837,7 +1837,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 114,
+ "line": 121,
"description": "Walks the paths and parses the directory contents",
"itemtype": "method",
"name": "walk",
@@ -1848,7 +1848,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 124,
+ "line": 131,
"description": "Walks the passed directory and grabs all the files recursively.",
"itemtype": "method",
"name": "parsedir",
@@ -1866,7 +1866,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 155,
+ "line": 162,
"description": "Gathers all the file data and populates the filemap and dirmap hashes.",
"itemtype": "method",
"name": "parsefiles",
@@ -1889,7 +1889,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 206,
+ "line": 213,
"description": "Writes the parser JSON data to disk.",
"itemtype": "method",
"name": "writeJSON",
@@ -1911,7 +1911,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 266,
+ "line": 273,
"description": "Process the config, walk the file tree and write out the JSON data.",
"itemtype": "method",
"name": "run",
@@ -1924,7 +1924,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 272,
+ "line": 279,
"description": "Timestamp holder so we know when YUIDoc started the parse process.",
"itemtype": "property",
"name": "starttime",
@@ -1934,7 +1934,7 @@
},
{
"file": "lib/yuidoc.js",
- "line": 290,
+ "line": 297,
"description": "Timestamp holder so we know when YUIDoc has finished the parse process.",
"itemtype": "property",
"name": "endtime",
@@ -198,6 +198,10 @@ <h1 class="file-heading">File: lib&#x2F;cli.js</h1>
var theme = args.shift();
options.themedir = path.join(__dirname, &#x27;..&#x2F;&#x27;, &#x27;themes&#x27;, theme);
break;
+ case &quot;-q&quot;:
+ case &quot;--quiet&quot;:
+ options.quiet = true;
+ break;
default:
if (!options.paths) {
options.paths = [];
@@ -206,6 +210,10 @@ <h1 class="file-heading">File: lib&#x2F;cli.js</h1>
}
}
+if (options.quiet) {
+ Y.applyConfig({ debug: false });
+}
+
Y.log(&#x27;Starting YUIDoc@&#x27; + Y.packageInfo.version + &#x27; using YUI@&#x27; + Y.version + &#x27; with NodeJS@&#x27; + process.versions.node, &#x27;info&#x27;, &#x27;yuidoc&#x27;);
var starttime = (new Date).getTime();
@@ -132,7 +132,8 @@ <h1 class="file-heading">File: lib&#x2F;index.js</h1>
process.on(&#x27;uncaughtException&#x27;, function(msg) {
var Y = YUI(),
meta = JSON.parse(fs.readFileSync(metaPath));
-
+
+ Y.applyConfig({ debug: true });
Y.log(&#x27;--------------------------------------------------------------------------&#x27;, &#x27;error&#x27;);
Y.log(&#x27;An uncaught YUIDoc error has occurred, stack trace given below&#x27;, &#x27;error&#x27;);
Y.log(&#x27;--------------------------------------------------------------------------&#x27;, &#x27;error&#x27;);
@@ -137,6 +137,7 @@ <h1 class="file-heading">File: lib&#x2F;yuidoc.js</h1>
*&#x2F;
var OPTIONS = {
+ quiet: false,
writeJSON: true,
outdir: path.join(process.cwd(), &#x27;out&#x27;),
extension: &#x27;.js&#x27;,
@@ -201,6 +202,12 @@ <h1 class="file-heading">File: lib&#x2F;yuidoc.js</h1>
*&#x2F;
this.options = Y.merge(OPTIONS, config);
+ if (this.options.quiet) {
+ Y.applyConfig({
+ debug: false
+ });
+ }
+
};
Y.YUIDoc.prototype = {
@@ -102,7 +102,7 @@ <h2 class="off-left">APIs</h2>
<div class="foundat">
- Defined in: <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l48"><code>lib&#x2F;yuidoc.js:48</code></a>
+ Defined in: <a href="..&#x2F;files&#x2F;lib_yuidoc.js.html#l49"><code>lib&#x2F;yuidoc.js:49</code></a>
</div>
@@ -54,6 +54,7 @@
-o, --out &lt;directory path&gt; Path to put the generated files (defaults to .&#x2F;out)
-t, --themedir &lt;directory path&gt; Path to a custom theme directory containing Handlebars templates
-h, --help Show this help
+ -q, --quiet Supress logging output
-T, --theme &lt;simple|default&gt; Choose one of the built in themes (default is default)
--server &lt;port&gt; Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)

0 comments on commit dcd0d6d

Please sign in to comment.