Skip to content

Commit

Permalink
docs(api): update yuidoc comments and generate new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@dylanfoster
dylanfoster committed Mar 17, 2017
1 parent 33d1297 commit ef3e044
Show file tree
Hide file tree
Showing 32 changed files with 2,917 additions and 477 deletions.
4 changes: 3 additions & 1 deletion docs/api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ YUI.add("yuidoc-meta", function(Y) {
"Controller",
"Model",
"ModelManager",
"Registry",
"Route",
"RouteSegment",
"Router"
"Router",
"containment"
],
"modules": [
"parch"
Expand Down
142 changes: 124 additions & 18 deletions docs/classes/Application.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ <h4 class="panel-title">
<li>
<a href="../classes/Application.html">Application</a>
</li>
<li>
<a href="../classes/containment.html">containment</a>
</li>
<li>
<a href="../classes/Controller.html">Controller</a>
</li>
Expand All @@ -100,6 +103,9 @@ <h4 class="panel-title">
<li>
<a href="../classes/ModelManager.html">ModelManager</a>
</li>
<li>
<a href="../classes/Registry.html">Registry</a>
</li>
<li>
<a href="../classes/Route.html">Route</a>
</li>
Expand All @@ -122,7 +128,7 @@ <h4 class="panel-title">

<div class="page-header">
<h1> <i class="fa fa-bookmark-o" aria-hidden="true"></i> Application Class
<a class="pull-right file-edit" href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L34" target="_blank">
<a class="pull-right file-edit" href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L18" target="_blank">
<i class="fa fa-pencil" aria-hidden="true"></i>
</a>
</h1>
Expand All @@ -136,7 +142,7 @@ <h1> <i class="fa fa-bookmark-o" aria-hidden="true"></i> Application Class


<div class="foundat">
Defined In: <a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L34">src/application.js:34</a>
Defined In: <a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L18">src/application.js:18</a>
</div>
</div>

Expand Down Expand Up @@ -190,11 +196,15 @@ <h3>Methods</h3>

<ul class="index-list methods">
<li class="index-item method private">
<a href="#method__addModels">_addModels</a>
<a href="#method__configure">_configure</a>

</li>
<li class="index-item method private">
<a href="#method__getProjectDirectory">_getProjectDirectory</a>

</li>
<li class="index-item method private">
<a href="#method__associateModels">_associateModels</a>
<a href="#method__initialize">_initialize</a>

</li>
<li class="index-item method">
Expand All @@ -214,14 +224,23 @@ <h3>Methods</h3>

<div id="tab_methods" role="tabpanel" class="tab-pane">
<div class="item-list">
<div id="method__addModels" class="method item private">
<div id="method__configure" class="method item private">
<span class="method-signature">
<span class="name anchorable-toc">
<a class="fa fa-link toc-anchor" href="#method__addModels"></a>
_addModels
<a class="fa fa-link toc-anchor" href="#method__configure"></a>
_configure
</span>

<span class="paren">()</span>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
</span>


Expand All @@ -234,28 +253,102 @@ <h3>Methods</h3>
<div class="meta">
<p>
Defined in
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L145">src/application.js:145</a>
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L81">src/application.js:81</a>
</p>



</div>

<div class="description"><p>Loads the models into the model manager using
<a href="../classes/ModelManager.html#method_addModel" class="crosslink">ModelManager#addModel</a></p>
<div class="description"><p>Normalizes constructor options</p>
</div>

<div class="params">
<h4>Parameters:</h4>

<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>


<div class="param-description"><p>user passed config options</p>
</div>
<div id="method__associateModels" class="method item private">

</li>
</ul>
</div>

<div class="returns">
<h4>Returns:</h4>

<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
<p>final config option</p>

</div>
</div>

</div>
<div id="method__getProjectDirectory" class="method item private">
<span class="method-signature">
<span class="name anchorable-toc">
<a class="fa fa-link toc-anchor" href="#method__associateModels"></a>
_associateModels
<a class="fa fa-link toc-anchor" href="#method__getProjectDirectory"></a>
_getProjectDirectory
</span>

<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
</span>



<span class="flag private">private</span>




<div class="meta">
<p>
Defined in
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L104">src/application.js:104</a>
</p>



</div>

<div class="description"><p>Returns the project directory (cwd) from which Application is being instantiated</p>
</div>


<div class="returns">
<h4>Returns:</h4>

<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
<p>directory</p>

</div>
</div>

</div>
<div id="method__initialize" class="method item private">
<span class="method-signature">
<span class="name anchorable-toc">
<a class="fa fa-link toc-anchor" href="#method__initialize"></a>
_initialize
</span>

<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
</span>


Expand All @@ -268,16 +361,29 @@ <h3>Methods</h3>
<div class="meta">
<p>
Defined in
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L160">src/application.js:160</a>
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L118">src/application.js:118</a>
</p>



</div>

<div class="description"><p>runs associations for each model</p>
<div class="description"><p>Run an initializer by name</p>
</div>

<div class="params">
<h4>Parameters:</h4>

<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>



</li>
</ul>
</div>


</div>
Expand All @@ -303,7 +409,7 @@ <h3>Methods</h3>
<div class="meta">
<p>
Defined in
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L121">src/application.js:121</a>
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L55">src/application.js:55</a>
</p>


Expand Down Expand Up @@ -353,7 +459,7 @@ <h4>Returns:</h4>
<div class="meta">
<p>
Defined in
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L132">src/application.js:132</a>
<a href="https://github.com/dylanfoster/parch/blob/0/src/application.js#L67">src/application.js:67</a>
</p>


Expand Down

0 comments on commit ef3e044

Please sign in to comment.