Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@davglass
davglass committed Oct 22, 2012
1 parent 6839c6f commit 9cdc845
Show file tree
Hide file tree
Showing 29 changed files with 375 additions and 359 deletions.
2 changes: 1 addition & 1 deletion api/classes/CLI.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/DocBuilder.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/DocParser.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/DocView.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/Files.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
6 changes: 3 additions & 3 deletions api/classes/Help.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down Expand Up @@ -238,7 +238,7 @@ <h3 class="name"><code>renderHelp</code></h3>



<a href="..&#x2F;files&#x2F;lib_help.js.html#l58"><code>lib&#x2F;help.js:58</code></a>
<a href="..&#x2F;files&#x2F;lib_help.js.html#l59"><code>lib&#x2F;help.js:59</code></a>

</p>

Expand Down Expand Up @@ -305,7 +305,7 @@ <h3 class="name"><code>showHelp</code></h3>



<a href="..&#x2F;files&#x2F;lib_help.js.html#l68"><code>lib&#x2F;help.js:68</code></a>
<a href="..&#x2F;files&#x2F;lib_help.js.html#l69"><code>lib&#x2F;help.js:69</code></a>

</p>

Expand Down
2 changes: 1 addition & 1 deletion api/classes/Main.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/Options.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/classes/Server.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
24 changes: 12 additions & 12 deletions api/classes/Utils.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down Expand Up @@ -294,7 +294,7 @@ <h3 class="name"><code>escapeHTML</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l29"><code>lib&#x2F;utils.js:29</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l31"><code>lib&#x2F;utils.js:31</code></a>

</p>

Expand Down Expand Up @@ -398,7 +398,7 @@ <h3 class="name"><code>fixType</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l405"><code>lib&#x2F;utils.js:405</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l407"><code>lib&#x2F;utils.js:407</code></a>

</p>

Expand Down Expand Up @@ -502,7 +502,7 @@ <h3 class="name"><code>getDirs</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l309"><code>lib&#x2F;utils.js:309</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l311"><code>lib&#x2F;utils.js:311</code></a>

</p>

Expand Down Expand Up @@ -606,7 +606,7 @@ <h3 class="name"><code>getLayouts</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l63"><code>lib&#x2F;utils.js:63</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l65"><code>lib&#x2F;utils.js:65</code></a>

</p>

Expand Down Expand Up @@ -711,7 +711,7 @@ <h3 class="name"><code>getPage</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l76"><code>lib&#x2F;utils.js:76</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l78"><code>lib&#x2F;utils.js:78</code></a>

</p>

Expand Down Expand Up @@ -815,7 +815,7 @@ <h3 class="name"><code>getPages</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l89"><code>lib&#x2F;utils.js:89</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l91"><code>lib&#x2F;utils.js:91</code></a>

</p>

Expand Down Expand Up @@ -921,7 +921,7 @@ <h3 class="name"><code>getPartials</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l120"><code>lib&#x2F;utils.js:120</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l122"><code>lib&#x2F;utils.js:122</code></a>

</p>

Expand Down Expand Up @@ -1022,7 +1022,7 @@ <h3 class="name"><code>getProjectData</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l223"><code>lib&#x2F;utils.js:223</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l225"><code>lib&#x2F;utils.js:225</code></a>

</p>

Expand Down Expand Up @@ -1122,7 +1122,7 @@ <h3 class="name"><code>prepare</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l134"><code>lib&#x2F;utils.js:134</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l136"><code>lib&#x2F;utils.js:136</code></a>

</p>

Expand Down Expand Up @@ -1275,7 +1275,7 @@ <h3 class="name"><code>unindent</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l42"><code>lib&#x2F;utils.js:42</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l44"><code>lib&#x2F;utils.js:44</code></a>

</p>

Expand Down Expand Up @@ -1384,7 +1384,7 @@ <h3 class="name"><code>validatePaths</code></h3>



<a href="..&#x2F;files&#x2F;lib_utils.js.html#l336"><code>lib&#x2F;utils.js:336</code></a>
<a href="..&#x2F;files&#x2F;lib_utils.js.html#l338"><code>lib&#x2F;utils.js:338</code></a>

</p>

Expand Down
2 changes: 1 addition & 1 deletion api/classes/YUIDoc.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
28 changes: 14 additions & 14 deletions api/data.json
View file
Expand Up @@ -3,7 +3,7 @@
"name": "YUIDoc",
"logo": "http://yuilibrary.com/img/yui-logo.png",
"description": "YUIDoc, YUI's JavaScript Documentation engine.",
"version": "0.3.29"
"version": "0.3.30"
},
"files": {
"lib/builder.js": {
Expand Down Expand Up @@ -1724,7 +1724,7 @@
},
{
"file": "lib/help.js",
"line": 58,
"line": 59,
"description": "Render the help message as a string",
"itemtype": "method",
"name": "renderHelp",
Expand All @@ -1737,7 +1737,7 @@
},
{
"file": "lib/help.js",
"line": 68,
"line": 69,
"description": "Display the help message, write it to the screen and exit",
"itemtype": "method",
"name": "showHelp",
Expand Down Expand Up @@ -1922,7 +1922,7 @@
},
{
"file": "lib/utils.js",
"line": 29,
"line": 31,
"description": "Escapes HTML characters in _html_.",
"itemtype": "method",
"name": "escapeHTML",
Expand All @@ -1942,7 +1942,7 @@
},
{
"file": "lib/utils.js",
"line": 42,
"line": 44,
"description": "Normalizes the initial indentation of the given _content_ so that the first line\nis unindented, and all other lines are unindented to the same degree as the\nfirst line. So if the first line has four spaces at the beginning, then all\nlines will be unindented four spaces.",
"itemtype": "method",
"name": "unindent",
Expand All @@ -1964,7 +1964,7 @@
},
{
"file": "lib/utils.js",
"line": 63,
"line": 65,
"description": "Like `getPages()`, but returns only the files under the `layout/` subdirectory\nof the specified _dir_.",
"itemtype": "method",
"name": "getLayouts",
Expand All @@ -1984,7 +1984,7 @@
},
{
"file": "lib/utils.js",
"line": 76,
"line": 78,
"description": "Loads and returns the content of the specified page file.",
"itemtype": "method",
"name": "getPage",
Expand All @@ -2004,7 +2004,7 @@
},
{
"file": "lib/utils.js",
"line": 89,
"line": 91,
"description": "Loads pages (files with a `.handlebars` extension) in the specified directory and\nreturns an object containing a mapping of page names (the part of the filename)\npreceding the `.handlebars` extension) to page content.",
"itemtype": "method",
"name": "getPages",
Expand All @@ -2024,7 +2024,7 @@
},
{
"file": "lib/utils.js",
"line": 120,
"line": 122,
"description": "Like `getPages()`, but returns only the files under the `partial/` subdirectory\nof the specified _dir_.",
"itemtype": "method",
"name": "getPartials",
Expand All @@ -2044,7 +2044,7 @@
},
{
"file": "lib/utils.js",
"line": 134,
"line": 136,
"description": "Mix/merge/munge data into the template.",
"itemtype": "method",
"name": "prepare",
Expand Down Expand Up @@ -2082,7 +2082,7 @@
},
{
"file": "lib/utils.js",
"line": 223,
"line": 225,
"description": "Walk the directory tree to locate the yuidoc.json file.",
"itemtype": "method",
"name": "getProjectData",
Expand All @@ -2100,7 +2100,7 @@
},
{
"file": "lib/utils.js",
"line": 309,
"line": 311,
"description": "Walks the tree from this dir and returns all the subdirs",
"itemtype": "method",
"name": "getDirs",
Expand All @@ -2120,7 +2120,7 @@
},
{
"file": "lib/utils.js",
"line": 336,
"line": 338,
"description": "Make sure all the paths passed are directories and that they are not in the ignore list.",
"itemtype": "method",
"name": "validatePaths",
Expand All @@ -2143,7 +2143,7 @@
},
{
"file": "lib/utils.js",
"line": 405,
"line": 407,
"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",
Expand Down
6 changes: 3 additions & 3 deletions api/files/lib_builder.js.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down Expand Up @@ -1564,7 +1564,7 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
opts = self.populateFiles(opts);

opts.meta.fileName = data.name;
fs.readFile(opts.meta.fileName, &#x27;utf8&#x27;, Y.rbind(function(err, str, opts, data) {
fs.readFile(opts.meta.fileName, Y.charset, Y.rbind(function(err, str, opts, data) {
if (err) {
Y.log(err, &#x27;error&#x27;, &#x27;builder&#x27;);
cb(err);
Expand Down Expand Up @@ -1592,7 +1592,7 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
Y.log(&#x27;Writing API Meta Data&#x27;, &#x27;info&#x27;, &#x27;builder&#x27;);
var self = this;
this.renderAPIMeta(function(js) {
fs.writeFile(path.join(self.options.outdir, &#x27;api.js&#x27;), js, &#x27;utf8&#x27;, cb);
fs.writeFile(path.join(self.options.outdir, &#x27;api.js&#x27;), js, Y.charset, cb);
});
},
&#x2F;**
Expand Down
2 changes: 1 addition & 1 deletion api/files/lib_cli.js.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/files/lib_docparser.js.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down
2 changes: 1 addition & 1 deletion api/files/lib_docview.js.html
View file
Expand Up @@ -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.29</em>
<em>API Docs for: 0.3.30</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand Down

0 comments on commit 9cdc845

Please sign in to comment.