Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@rajdeep
rajdeep committed May 14, 2024
1 parent 74cb1af commit c2bb656
Show file tree
Hide file tree
Showing 216 changed files with 17,164 additions and 409 deletions.
144 changes: 142 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Proton Docs</a> (69% documented)</p>
<p><a href="index.html">Proton Docs</a> (68% documented)</p>
<p class="header-right"><a href="https://github.com/rajdeep/proton"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -93,9 +93,21 @@
<li class="nav-group-task">
<a href="Classes/StrikethroughCommand.html">StrikethroughCommand</a>
</li>
<li class="nav-group-task">
<a href="Classes/TableCell.html">TableCell</a>
</li>
<li class="nav-group-task">
<a href="Classes/TableCellContentView.html">TableCellContentView</a>
</li>
<li class="nav-group-task">
<a href="Classes/TableView.html">TableView</a>
</li>
<li class="nav-group-task">
<a href="Classes/UnderlineCommand.html">UnderlineCommand</a>
</li>
<li class="nav-group-task">
<a href="Classes/Utility.html">Utility</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -146,6 +158,9 @@
<li class="nav-group-task">
<a href="Enums/RoundedCornerStyle.html">RoundedCornerStyle</a>
</li>
<li class="nav-group-task">
<a href="Enums/TableViewError.html">TableViewError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -255,6 +270,9 @@
<li class="nav-group-task">
<a href="Protocols/SequenceGenerator.html">SequenceGenerator</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TableViewDelegate.html">TableViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TextProcessing.html">TextProcessing</a>
</li>
Expand Down Expand Up @@ -870,6 +888,7 @@ <h4>Declaration</h4>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">GridCell</span><span class="p">:</span> <span class="kt"><a href="Protocols/BoundsObserving.html">BoundsObserving</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">GridCell</span><span class="p">:</span> <span class="kt"><a href="Protocols/EditorViewDelegate.html">EditorViewDelegate</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">GridCell</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">GridCell</span><span class="p">:</span> <span class="kt">Hashable</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -909,6 +928,127 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton7UtilityC"></a>
<a name="//apple_ref/swift/Class/Utility" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton7UtilityC">Utility</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/Utility.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">class</span> <span class="kt">Utility</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton9TableCellC"></a>
<a name="//apple_ref/swift/Class/TableCell" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton9TableCellC">TableCell</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/TableCell.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">class</span> <span class="kt">TableCell</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableCell</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableCell</span><span class="p">:</span> <span class="kt">Hashable</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Proton@objc(cs)TableCellContentView"></a>
<a name="//apple_ref/swift/Class/TableCellContentView" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Proton@objc(cs)TableCellContentView">TableCellContentView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/TableCellContentView.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">class</span> <span class="kt">TableCellContentView</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableCellContentView</span><span class="p">:</span> <span class="kt"><a href="Protocols/BoundsObserving.html">BoundsObserving</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableCellContentView</span><span class="p">:</span> <span class="kt"><a href="Protocols/EditorViewDelegate.html">EditorViewDelegate</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Proton@objc(cs)TableView"></a>
<a name="//apple_ref/swift/Class/TableView" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Proton@objc(cs)TableView">TableView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A view that provides a tabular structure where each cell is an <code><a href="Classes/EditorView.html">EditorView</a></code>.
Since the cells contains an <code><a href="Classes/EditorView.html">EditorView</a></code> in itself, it is capable of hosting any attachment that <code><a href="Classes/EditorView.html">EditorView</a></code> can host
including another <code>TableView</code> as an attachment.</p>

<a href="Classes/TableView.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">class</span> <span class="kt">TableView</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableView</span><span class="p">:</span> <span class="kt">UIScrollViewDelegate</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableView</span><span class="p">:</span> <span class="kt"><a href="Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TableView</span><span class="p">:</span> <span class="kt"><a href="Protocols/BackgroundColorObserving.html">BackgroundColorObserving</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -954,7 +1094,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-04-04)</p>
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-05-15)</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>
</article>
Expand Down
49 changes: 47 additions & 2 deletions docs/Classes/Attachment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Attachment Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Proton Docs</a> (69% documented)</p>
<p><a href="../index.html">Proton Docs</a> (68% documented)</p>
<p class="header-right"><a href="https://github.com/rajdeep/proton"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -93,9 +93,21 @@
<li class="nav-group-task">
<a href="../Classes/StrikethroughCommand.html">StrikethroughCommand</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableCell.html">TableCell</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableCellContentView.html">TableCellContentView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableView.html">TableView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UnderlineCommand.html">UnderlineCommand</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Utility.html">Utility</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -146,6 +158,9 @@
<li class="nav-group-task">
<a href="../Enums/RoundedCornerStyle.html">RoundedCornerStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/TableViewError.html">TableViewError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -255,6 +270,9 @@
<li class="nav-group-task">
<a href="../Protocols/SequenceGenerator.html">SequenceGenerator</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TableViewDelegate.html">TableViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TextProcessing.html">TextProcessing</a>
</li>
Expand Down Expand Up @@ -776,6 +794,33 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton10AttachmentC16frameInContainerSo6CGRectVSgvp"></a>
<a name="//apple_ref/swift/Property/frameInContainer" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC16frameInContainerSo6CGRectVSgvp">frameInContainer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Attachment&rsquo;s frame in ints container <code><a href="../Classes/EditorView.html">EditorView</a></code>. The value may be nil if attachment is not rendered yet.</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">public</span> <span class="k">var</span> <span class="nv">frameInContainer</span><span class="p">:</span> <span class="kt">CGRect</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -1525,7 +1570,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-04-04)</p>
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-05-15)</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>
</article>
Expand Down
22 changes: 20 additions & 2 deletions docs/Classes/AttributesToggleCommand.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="AttributesToggleCommand Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Proton Docs</a> (69% documented)</p>
<p><a href="../index.html">Proton Docs</a> (68% documented)</p>
<p class="header-right"><a href="https://github.com/rajdeep/proton"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -93,9 +93,21 @@
<li class="nav-group-task">
<a href="../Classes/StrikethroughCommand.html">StrikethroughCommand</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableCell.html">TableCell</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableCellContentView.html">TableCellContentView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TableView.html">TableView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UnderlineCommand.html">UnderlineCommand</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Utility.html">Utility</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -146,6 +158,9 @@
<li class="nav-group-task">
<a href="../Enums/RoundedCornerStyle.html">RoundedCornerStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/TableViewError.html">TableViewError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -255,6 +270,9 @@
<li class="nav-group-task">
<a href="../Protocols/SequenceGenerator.html">SequenceGenerator</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TableViewDelegate.html">TableViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/TextProcessing.html">TextProcessing</a>
</li>
Expand Down Expand Up @@ -493,7 +511,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-04-04)</p>
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2024-05-15)</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>
</article>
Expand Down
Loading

0 comments on commit c2bb656

Please sign in to comment.