Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
runner authored and runner committed Jun 28, 2024
1 parent 7851042 commit 909ca51
Show file tree
Hide file tree
Showing 10 changed files with 99 additions and 1,312 deletions.
1 change: 1 addition & 0 deletions Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1069,6 +1069,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/VectorReal.html">VectorReal</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span><span class="p">:</span> <span class="kt"><a href="Protocols/Convex2Type.html">Convex2Type</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/Vector2Real.html">Vector2Real</a></span></code></pre>

</div>
Expand Down
43 changes: 43 additions & 0 deletions Extensions/Ellipse2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,7 @@ <h1>Ellipse2</h1>

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VectorReal.html">VectorReal</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span><span class="p">:</span> <span class="kt"><a href="../Protocols/Convex2Type.html">Convex2Type</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Vector2Real.html">Vector2Real</a></span></code></pre>

</div>
Expand Down Expand Up @@ -1093,6 +1094,48 @@ <h4>Declaration</h4>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Available%20where%20%60Vector%60%3A%20%60VectorFloatingPoint%60"></a>
<a name="//apple_ref/swift/Section/Available where `Vector`: `VectorFloatingPoint`" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Available%20where%20%60Vector%60%3A%20%60VectorFloatingPoint%60"></a>
<h3 class="section-name"><span>Available where <code>Vector</code>: <code><a href="../Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></code></span>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Geometria9EllipsoidVA2A11Vector2TypeRzAA19VectorFloatingPointRzrlE4focix1a_x1btyF"></a>
<a name="//apple_ref/swift/Method/foci()" class="dashAnchor"></a>
<a class="token" href="#/s:9Geometria9EllipsoidVA2A11Vector2TypeRzAA19VectorFloatingPointRzrlE4focix1a_x1btyF">foci()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Computes the focal points of this 2D ellipse, as two vectors in space
that form <a href="https://en.wikipedia.org/wiki/Ellipse#Pins-and-string_method">pins-and-string construction method</a>
for the ellipse.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">foci</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">a</span><span class="p">:</span> <span class="kt">Vector</span><span class="p">,</span> <span class="nv">b</span><span class="p">:</span> <span class="kt">Vector</span><span class="p">)</span></code></pre>

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

Expand Down
1 change: 1 addition & 0 deletions docsets/.docset/Contents/Resources/Documents/Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1069,6 +1069,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/VectorReal.html">VectorReal</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt"><a href="Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span><span class="p">:</span> <span class="kt"><a href="Protocols/Convex2Type.html">Convex2Type</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="Protocols/Vector2Real.html">Vector2Real</a></span></code></pre>

</div>
Expand Down
43 changes: 43 additions & 0 deletions docsets/.docset/Contents/Resources/Documents/Extensions/Ellipse2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,7 @@ <h1>Ellipse2</h1>

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VectorReal.html">VectorReal</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt"><a href="../Typealiases.html#/s:9Geometria8Ellipse2a">Ellipse2</a></span><span class="p">:</span> <span class="kt"><a href="../Protocols/Convex2Type.html">Convex2Type</a></span> <span class="k">where</span> <span class="kt">Vector</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Vector2Real.html">Vector2Real</a></span></code></pre>

</div>
Expand Down Expand Up @@ -1093,6 +1094,48 @@ <h4>Declaration</h4>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Available%20where%20%60Vector%60%3A%20%60VectorFloatingPoint%60"></a>
<a name="//apple_ref/swift/Section/Available where `Vector`: `VectorFloatingPoint`" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Available%20where%20%60Vector%60%3A%20%60VectorFloatingPoint%60"></a>
<h3 class="section-name"><span>Available where <code>Vector</code>: <code><a href="../Protocols/VectorFloatingPoint.html">VectorFloatingPoint</a></code></span>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Geometria9EllipsoidVA2A11Vector2TypeRzAA19VectorFloatingPointRzrlE4focix1a_x1btyF"></a>
<a name="//apple_ref/swift/Method/foci()" class="dashAnchor"></a>
<a class="token" href="#/s:9Geometria9EllipsoidVA2A11Vector2TypeRzAA19VectorFloatingPointRzrlE4focix1a_x1btyF">foci()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Computes the focal points of this 2D ellipse, as two vectors in space
that form <a href="https://en.wikipedia.org/wiki/Ellipse#Pins-and-string_method">pins-and-string construction method</a>
for the ellipse.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">foci</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">a</span><span class="p">:</span> <span class="kt">Vector</span><span class="p">,</span> <span class="nv">b</span><span class="p">:</span> <span class="kt">Vector</span><span class="p">)</span></code></pre>

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

Expand Down
16 changes: 8 additions & 8 deletions docsets/.docset/Contents/Resources/Documents/badge.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docsets/.docset/Contents/Resources/Documents/search.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 909ca51

Please sign in to comment.