Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@billp
billp committed Apr 24, 2023
1 parent 04eab71 commit bcc608a
Show file tree
Hide file tree
Showing 74 changed files with 3,026 additions and 945 deletions.
139 changes: 70 additions & 69 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,15 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Cache.html">Cache</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Client.html">Client</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Configuration.html">Configuration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EndpointConfiguration.html">EndpointConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Environment.html">Environment</a>
</li>
Expand All @@ -80,12 +86,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Request.html">Request</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/RouteConfiguration.html">RouteConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Router.html">Router</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Transformer.html">Transformer</a>
</li>
Expand Down Expand Up @@ -137,6 +137,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/EndpointProtocol.html">EndpointProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/EnvironmentProtocol.html">EnvironmentProtocol</a>
</li>
Expand All @@ -146,9 +149,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/RequestMiddlewareProtocol.html">RequestMiddlewareProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/RouteProtocol.html">RouteProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/TransformerProtocol.html">TransformerProtocol</a>
</li>
Expand Down Expand Up @@ -263,6 +263,34 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12TermiNetwork6ClientC"></a>
<a name="//apple_ref/swift/Class/Client" class="dashAnchor"></a>
<a class="token" href="#/s:12TermiNetwork6ClientC">Client</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This class is used to create instances of Repository that can be used to start requests based on the given endpoint.</p>

<a href="Classes/Client.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Client</span><span class="o">&lt;</span><span class="kt">Repository</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Repository</span> <span class="p">:</span> <span class="kt"><a href="Protocols/EndpointProtocol.html">EndpointProtocol</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand All @@ -276,13 +304,14 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A configuration class that can be used with Environment, Router, Route and Request.
<p>A configuration class that can be used with Environment, Repository, Endpoint and Request.
A configuration object follows the following rules:</p>

<ol>
<li>When a Configuration object is passed to an Environment,
each Router with its routes and requests will inherit this configuration.</li>
<li>When a Configuration object is passed to Router, all its routes and requests will inherit this configuration.</li>
each Repository with its Endpoints and requests will inherit this configuration.</li>
<li>When a Configuration object is passed to Repository,
all its Endpoints and Requests will inherit this configuration.</li>
</ol>

<a href="Classes/Configuration.html" class="slightly-smaller">See more</a>
Expand All @@ -299,6 +328,34 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12TermiNetwork21EndpointConfigurationC"></a>
<a name="//apple_ref/swift/Class/EndpointConfiguration" class="dashAnchor"></a>
<a class="token" href="#/s:12TermiNetwork21EndpointConfigurationC">EndpointConfiguration</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Endpoint configuration class which is used in EndpointProtocol implementations.</p>

<a href="Classes/EndpointConfiguration.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">EndpointConfiguration</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -482,62 +539,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12TermiNetwork18RouteConfigurationC"></a>
<a name="//apple_ref/swift/Class/RouteConfiguration" class="dashAnchor"></a>
<a class="token" href="#/s:12TermiNetwork18RouteConfigurationC">RouteConfiguration</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Route configuration class which is used in Route protocol implementations.</p>

<a href="Classes/RouteConfiguration.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">RouteConfiguration</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12TermiNetwork6RouterC"></a>
<a name="//apple_ref/swift/Class/Router" class="dashAnchor"></a>
<a class="token" href="#/s:12TermiNetwork6RouterC">Router</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This class is used to create instances of Router that can be used to start requests based on the given Route.</p>

<a href="Classes/Router.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Router</span><span class="o">&lt;</span><span class="kt">Route</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Route</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RouteProtocol.html">RouteProtocol</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
Expand All @@ -546,7 +547,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2023-04-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
Expand Down
20 changes: 10 additions & 10 deletions docs/Classes/Cache.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,15 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Cache.html">Cache</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Client.html">Client</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Configuration.html">Configuration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EndpointConfiguration.html">EndpointConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Environment.html">Environment</a>
</li>
Expand All @@ -80,12 +86,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/RouteConfiguration.html">RouteConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Router.html">Router</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Transformer.html">Transformer</a>
</li>
Expand Down Expand Up @@ -137,6 +137,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/EndpointProtocol.html">EndpointProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/EnvironmentProtocol.html">EnvironmentProtocol</a>
</li>
Expand All @@ -146,9 +149,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/RequestMiddlewareProtocol.html">RequestMiddlewareProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
</li>
Expand Down Expand Up @@ -362,7 +362,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2023-04-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit bcc608a

Please sign in to comment.