Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rajdeep
rajdeep committed Oct 10, 2023
1 parent d05432d commit 0c7f32c
Show file tree
Hide file tree
Showing 189 changed files with 4,256 additions and 459 deletions.
11 changes: 9 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> (71% documented)</p>
<p><a href="index.html">Proton Docs</a> (70% 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 @@ -177,6 +177,12 @@
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/AsyncAttachmentRenderingDelegate.html">AsyncAttachmentRenderingDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/AsyncTextResolving.html">AsyncTextResolving</a>
</li>
Expand Down Expand Up @@ -868,6 +874,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">GridView</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">GridView</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">GridView</span><span class="p">:</span> <span class="kt"><a href="Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -919,7 +926,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-08-12)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-10-10)</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
174 changes: 172 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> (71% documented)</p>
<p><a href="../index.html">Proton Docs</a> (70% 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 @@ -177,6 +177,12 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/AsyncAttachmentRenderingDelegate.html">AsyncAttachmentRenderingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/AsyncTextResolving.html">AsyncTextResolving</a>
</li>
Expand Down Expand Up @@ -350,6 +356,33 @@ <h1>Attachment</h1>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:6Proton10AttachmentC2idSSvp"></a>
<a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC2idSSvp">id</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Identifier that uniquely identifies an attachment. Auto-generated.</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">let</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -378,6 +411,116 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton10AttachmentC15estimatedHeight14CoreFoundation7CGFloatVvp"></a>
<a name="//apple_ref/swift/Property/estimatedHeight" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC15estimatedHeight14CoreFoundation7CGFloatVvp">estimatedHeight</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Estimated height for attachment when it is rendering asynchronously.
This will result in a blank placeholder with given height for the attachment to render.
When rendering completed, the Editor content will readjust to accomodate the actual height of <code>Attachment</code></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">estimatedHeight</span><span class="p">:</span> <span class="kt">CGFloat</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton10AttachmentC22needsDeferredRenderingSbvp"></a>
<a name="//apple_ref/swift/Property/needsDeferredRendering" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC22needsDeferredRenderingSbvp">needsDeferredRendering</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>

</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">needsDeferredRendering</span><span class="p">:</span> <span class="kt">Bool</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>
<a name="/s:6Proton10AttachmentC11isBlockTypeSbvp"></a>
<a name="//apple_ref/swift/Property/isBlockType" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC11isBlockTypeSbvp">isBlockType</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>

</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">isBlockType</span><span class="p">:</span> <span class="kt">Bool</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>
<a name="/s:6Proton10AttachmentC12isInlineTypeSbvp"></a>
<a name="//apple_ref/swift/Property/isInlineType" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC12isInlineTypeSbvp">isInlineType</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>

</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">isInlineType</span><span class="p">:</span> <span class="kt">Bool</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 @@ -465,6 +608,33 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Proton10AttachmentC11contentSizeSo6CGSizeVSgvp"></a>
<a name="//apple_ref/swift/Property/contentSize" class="dashAnchor"></a>
<a class="token" href="#/s:6Proton10AttachmentC11contentSizeSo6CGSizeVSgvp">contentSize</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>

</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">contentSize</span><span class="p">:</span> <span class="kt">CGSize</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 @@ -1168,7 +1338,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-08-12)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-10-10)</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
10 changes: 8 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> (71% documented)</p>
<p><a href="../index.html">Proton Docs</a> (70% 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 @@ -177,6 +177,12 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/AsyncAttachmentRenderingDelegate.html">AsyncAttachmentRenderingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/AsyncTextResolving.html">AsyncTextResolving</a>
</li>
Expand Down Expand Up @@ -460,7 +466,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-08-12)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-10-10)</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
10 changes: 8 additions & 2 deletions docs/Classes/BackgroundStyle.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="BackgroundStyle Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Proton Docs</a> (71% documented)</p>
<p><a href="../index.html">Proton Docs</a> (70% 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 @@ -177,6 +177,12 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/AsyncAttachmentRenderingDelegate.html">AsyncAttachmentRenderingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/AsyncTextResolving.html">AsyncTextResolving</a>
</li>
Expand Down Expand Up @@ -627,7 +633,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-08-12)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-10-10)</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
10 changes: 8 additions & 2 deletions docs/Classes/BoldCommand.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="BoldCommand Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Proton Docs</a> (71% documented)</p>
<p><a href="../index.html">Proton Docs</a> (70% 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 @@ -177,6 +177,12 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/AsyncAttachmentRenderingDelegate.html">AsyncAttachmentRenderingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:6Proton23AsyncDeferredRenderableP">AsyncDeferredRenderable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/AsyncTextResolving.html">AsyncTextResolving</a>
</li>
Expand Down Expand Up @@ -381,7 +387,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-08-12)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-10-10)</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 0c7f32c

Please sign in to comment.