Skip to content

Commit

Permalink
Doc Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
davglass committed May 31, 2011
1 parent eb0aa02 commit ac3b8a0
Show file tree
Hide file tree
Showing 8 changed files with 140 additions and 68 deletions.
38 changes: 27 additions & 11 deletions api/classes/DocBuilder.html
Expand Up @@ -113,7 +113,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_437"><code>lib&#x2F;builder.js:437</code></a>
<a href="../files/lib_builder.js.html#LINE_440"><code>lib&#x2F;builder.js:440</code></a>
</span>
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>, this handles <code>&#x60;</code>'s in fields
that are not parsed by the <strong>Markdown</strong> parser.</p>
Expand All @@ -137,6 +137,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;HTML&gt; The parsed HTML</div>



</div>


Expand All @@ -148,7 +149,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_426"><code>lib&#x2F;builder.js:426</code></a>
<a href="../files/lib_builder.js.html#LINE_429"><code>lib&#x2F;builder.js:429</code></a>
</span>
<p>Parses <code>&lt;pre&gt;&lt;code&gt;</code> tags and adds the <strong>prettyprint</strong> <code>className</code> to them</p>

Expand All @@ -171,6 +172,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;HTML&gt; The parsed HTML</div>



</div>


Expand Down Expand Up @@ -206,6 +208,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a>&gt; The augmented object</div>



</div>


Expand All @@ -217,7 +220,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_884"><code>lib&#x2F;builder.js:884</code></a>
<a href="../files/lib_builder.js.html#LINE_897"><code>lib&#x2F;builder.js:897</code></a>
</span>
<p>Compiles the templates from the meta-data provided by DocParser</p>

Expand All @@ -236,6 +239,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -247,7 +251,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_871"><code>lib&#x2F;builder.js:871</code></a>
<a href="../files/lib_builder.js.html#LINE_884"><code>lib&#x2F;builder.js:884</code></a>
</span>
<p>Normalizes a file path to a writable filename:</p>

Expand All @@ -274,6 +278,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a>&gt; The filtered file path</div>



</div>


Expand All @@ -294,6 +299,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a>&gt; The project metadata</div>



</div>


Expand All @@ -305,7 +311,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_402"><code>lib&#x2F;builder.js:402</code></a>
<a href="../files/lib_builder.js.html#LINE_405"><code>lib&#x2F;builder.js:405</code></a>
</span>
<p>Makes the default directories needed</p>

Expand All @@ -324,6 +330,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -335,7 +342,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_802"><code>lib&#x2F;builder.js:802</code></a>
<a href="../files/lib_builder.js.html#LINE_815"><code>lib&#x2F;builder.js:815</code></a>
</span>
<p>Sort method of array of objects with a property called <strong>name</strong></p>

Expand Down Expand Up @@ -367,6 +374,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a>&gt; 1, -1 or 0 for sorting.</div>



</div>


Expand Down Expand Up @@ -401,6 +409,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a>&gt; The modified options</div>



</div>


Expand Down Expand Up @@ -435,6 +444,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a>&gt; The modified options</div>



</div>


Expand Down Expand Up @@ -469,6 +479,7 @@ <h2 class="no-toc">Files</h2>
<br><div class="returns"><strong>Returns:</strong> &lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a>&gt; The modified options</div>



</div>


Expand All @@ -480,7 +491,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_456"><code>lib&#x2F;builder.js:456</code></a>
<a href="../files/lib_builder.js.html#LINE_459"><code>lib&#x2F;builder.js:459</code></a>
</span>
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>
Renders the handlebars templates with the default View class.</p>
Expand Down Expand Up @@ -544,6 +555,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -555,7 +567,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_639"><code>lib&#x2F;builder.js:639</code></a>
<a href="../files/lib_builder.js.html#LINE_642"><code>lib&#x2F;builder.js:642</code></a>
</span>
<p>Generates the class files under "out"/classes/</p>

Expand All @@ -574,6 +586,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -585,7 +598,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_825"><code>lib&#x2F;builder.js:825</code></a>
<a href="../files/lib_builder.js.html#LINE_838"><code>lib&#x2F;builder.js:838</code></a>
</span>
<p>Generates the syntax files under <code>"out"/files/</code></p>

Expand All @@ -604,6 +617,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -615,7 +629,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_506"><code>lib&#x2F;builder.js:506</code></a>
<a href="../files/lib_builder.js.html#LINE_509"><code>lib&#x2F;builder.js:509</code></a>
</span>
<p>Generates the index.html file</p>

Expand All @@ -634,6 +648,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand All @@ -645,7 +660,7 @@ <h2 class="no-toc">Files</h2>



<a href="../files/lib_builder.js.html#LINE_532"><code>lib&#x2F;builder.js:532</code></a>
<a href="../files/lib_builder.js.html#LINE_535"><code>lib&#x2F;builder.js:535</code></a>
</span>
<p>Generates the module files under "out"/modules/</p>

Expand All @@ -664,6 +679,7 @@ <h2 class="no-toc">Files</h2>
</ul>



</div>


Expand Down

0 comments on commit ac3b8a0

Please sign in to comment.