Update dokka documentation

L-Briand · Feb 9, 2024 · 5ea7ab6 · 5ea7ab6
1 parent 5821acb
commit 5ea7ab6
Show file tree

Hide file tree

Showing 113 changed files with 1,408 additions and 208 deletions.
diff --git a/docs/either/net.orandja.either/-either-serializer/-either-serializer.html b/docs/either/net.orandja.either/-either-serializer/-either-serializer.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@ <h1 class="cover"><span>Either</span><wbr></wbr><span><span>Serializer</span></s
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">leftDelegate<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">L</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">rightDelegate<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>L</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type of the value on the left side of <a href="../-either/index.html">Either</a></p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>R</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type of the value on the right side of <a href="../-either/index.html">Either</a></p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either-serializer/descriptor.html b/docs/either/net.orandja.either/-either-serializer/descriptor.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@ <h1 class="cover"><span><span>descriptor</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="descriptor.html">descriptor</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.descriptors/SerialDescriptor///PointingToDeclaration/">SerialDescriptor</span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either-serializer/deserialize.html b/docs/either/net.orandja.either/-either-serializer/deserialize.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@ <h1 class="cover"><span><span>deserialize</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deserialize.html"><span class="token function">deserialize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">decoder<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.encoding/Decoder///PointingToDeclaration/">Decoder</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-either/index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt;</span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either-serializer/index.html b/docs/either/net.orandja.either/-either-serializer/index.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -146,7 +146,7 @@ <h2 class="">Functions</h2>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either-serializer/serialize.html b/docs/either/net.orandja.either/-either-serializer/serialize.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@ <h1 class="cover"><span><span>serialize</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="serialize.html"><span class="token function">serialize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">encoder<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.encoding/Encoder///PointingToDeclaration/">Encoder</span><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="../-either/index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either/index.html b/docs/either/net.orandja.either/-either/index.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -346,13 +346,43 @@ <h2 class="">Functions</h2>
               </div>
             </div>
           </div>
+<a data-name="-837836366%2FFunctions%2F788909594" anchor-label="tryLeft" id="-837836366%2FFunctions%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
+          <div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="../try-left.html"><span>try</span><wbr></wbr><span><span>Left</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-837836366%2FFunctions%2F788909594"></span>
+                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+              <div>
+                <div class="title">
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">infix inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-left.html">OldL</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-left.html">NewL</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-left.html">R</a><span class="token operator">&gt; </span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-left.html">OldL</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-left.html">R</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../try-left.html"><span class="token function">tryLeft</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../try-left.html">OldL</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-left.html">NewL</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-left.html">R</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-left.html">NewL</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-left.html">R</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Depending on <code class="lang-kotlin">this</code> Kind:</p></div></div></div>
+                </div>
+              </div>
+            </div>
+          </div>
+<a data-name="-482976767%2FFunctions%2F788909594" anchor-label="tryRight" id="-482976767%2FFunctions%2F788909594" data-filterable-set=":dokkaHtml/commonMain"></a>
+          <div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="../try-right.html"><span>try</span><wbr></wbr><span><span>Right</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-482976767%2FFunctions%2F788909594"></span>
+                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+              <div>
+                <div class="title">
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">infix inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-right.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-right.html">OldR</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-right.html">NewR</a><span class="token operator">&gt; </span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-right.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-right.html">OldR</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../try-right.html"><span class="token function">tryRight</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../try-right.html">OldR</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-right.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-right.html">NewR</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../try-right.html">L</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../try-right.html">NewR</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Depending on <code class="lang-kotlin">this</code> Kind:</p></div></div></div>
+                </div>
+              </div>
+            </div>
+          </div>
         </div>
       </div>
     </div>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/docs/either/net.orandja.either/-either/invert.html b/docs/either/net.orandja.either/-either/invert.html
@@ -45,7 +45,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.2.0            </div>
+1.2.1            </div>
         </div>
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -69,7 +69,7 @@ <h1 class="cover"><span><span>invert</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="invert.html"><span class="token function">invert</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">Either</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">L</a><span class="token operator">&gt;</span></div><p class="paragraph">Swap the type of <code class="lang-kotlin">this</code>. A <a href="../-left/index.html">Left</a> becomes <a href="../-right/index.html">Right</a>; A <a href="../-right/index.html">Right</a> becomes <a href="../-left/index.html">Left</a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">Inverted object.</p></span></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>