Update dokka docs

05nelsonm · 05nelsonm · commit 50b924f15b92 · 2025-02-06T07:35:48.000-05:00
diff --git a/index.html b/index.html
@@ -44,7 +44,7 @@
                     </a>
             </div>
             <div class="library-version">
-0.1.0            </div>
+0.2.0            </div>
         </div>
     </div>
     <div class="navigation-controls">
diff --git a/library/error/index.html b/library/error/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/navigation.html b/library/error/navigation.html
@@ -52,7 +52,12 @@
      <a href="../library/error/org.kotlincrypto.error/-key-exception/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon exception-class"></span><span class="nav-link-child"><span>Key</span><wbr><span><span>Exception</span></span></span></span></a>
     </div>
    </div>
-   <div class="sideMenuPart" id="error-nav-submenu-0-9" pageid="error::org.kotlincrypto.error/ShortBufferException///PointingToDeclaration//-1744543846">
+   <div class="sideMenuPart" id="error-nav-submenu-0-9" pageid="error::org.kotlincrypto.error//requireParam/#kotlin.Boolean/PointingToDeclaration//239568316">
+    <div class="overview">
+     <a href="../library/error/org.kotlincrypto.error/require-param.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon function"></span><span class="nav-link-child"><span>require</span><wbr><span><span>Param()</span></span></span></span></a>
+    </div>
+   </div>
+   <div class="sideMenuPart" id="error-nav-submenu-0-10" pageid="error::org.kotlincrypto.error/ShortBufferException///PointingToDeclaration//-1744543846">
     <div class="overview">
      <a href="../library/error/org.kotlincrypto.error/-short-buffer-exception/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon exception-class"></span><span class="nav-link-child"><span>Short</span><wbr><span>Buffer</span><wbr><span><span>Exception</span></span></span></span></a>
     </div>
diff --git a/library/error/org.kotlincrypto.error/-bad-padding-exception/-bad-padding-exception.html b/library/error/org.kotlincrypto.error/-bad-padding-exception/-bad-padding-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-bad-padding-exception/index.html b/library/error/org.kotlincrypto.error/-bad-padding-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-encoding-exception/-certificate-encoding-exception.html b/library/error/org.kotlincrypto.error/-certificate-encoding-exception/-certificate-encoding-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-encoding-exception/index.html b/library/error/org.kotlincrypto.error/-certificate-encoding-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-exception/-certificate-exception.html b/library/error/org.kotlincrypto.error/-certificate-exception/-certificate-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-exception/index.html b/library/error/org.kotlincrypto.error/-certificate-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-parsing-exception/-certificate-parsing-exception.html b/library/error/org.kotlincrypto.error/-certificate-parsing-exception/-certificate-parsing-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-certificate-parsing-exception/index.html b/library/error/org.kotlincrypto.error/-certificate-parsing-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-general-security-exception/-general-security-exception.html b/library/error/org.kotlincrypto.error/-general-security-exception/-general-security-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-general-security-exception/index.html b/library/error/org.kotlincrypto.error/-general-security-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-illegal-block-size-exception/-illegal-block-size-exception.html b/library/error/org.kotlincrypto.error/-illegal-block-size-exception/-illegal-block-size-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-illegal-block-size-exception/index.html b/library/error/org.kotlincrypto.error/-illegal-block-size-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-invalid-key-exception/-invalid-key-exception.html b/library/error/org.kotlincrypto.error/-invalid-key-exception/-invalid-key-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-invalid-key-exception/index.html b/library/error/org.kotlincrypto.error/-invalid-key-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-invalid-parameter-exception/-invalid-parameter-exception.html b/library/error/org.kotlincrypto.error/-invalid-parameter-exception/-invalid-parameter-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-invalid-parameter-exception/index.html b/library/error/org.kotlincrypto.error/-invalid-parameter-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-key-exception/-key-exception.html b/library/error/org.kotlincrypto.error/-key-exception/-key-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-key-exception/index.html b/library/error/org.kotlincrypto.error/-key-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-short-buffer-exception/-short-buffer-exception.html b/library/error/org.kotlincrypto.error/-short-buffer-exception/-short-buffer-exception.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/-short-buffer-exception/index.html b/library/error/org.kotlincrypto.error/-short-buffer-exception/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
diff --git a/library/error/org.kotlincrypto.error/index.html b/library/error/org.kotlincrypto.error/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../index.html">
                             error
                     </a>            </div>
-            <div class="library-version">0.1.0
+            <div class="library-version">0.2.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -66,7 +66,7 @@
     <h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
   </div>
   <div class="tabbedcontent">
-    <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button></div>
+    <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
     <div class="tabs-section-body">
       <div data-togglable="TYPE">
         <h2 class="">Types</h2>
@@ -242,6 +242,25 @@ <h2 class="">Types</h2>
           </div>
         </div>
       </div>
+      <div data-togglable="FUNCTION">
+        <h2 class="">Functions</h2>
+        <div class="table"><a data-name="105461187%2FFunctions%2F239568316" anchor-label="requireParam" id="105461187%2FFunctions%2F239568316" data-filterable-set=":library:error:dokkaHtmlPartial/commonMain"></a>
+          <div class="table-row" data-filterable-current=":library:error:dokkaHtmlPartial/commonMain" data-filterable-set=":library:error:dokkaHtmlPartial/commonMain">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="require-param.html"><span>require</span><wbr><span><span>Param</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="105461187%2FFunctions%2F239568316"></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=":library:error:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="require-param.html"><span class="token function">requireParam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">condition<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Throws <a href="-invalid-parameter-exception/index.html">InvalidParameterException</a> when <a href="require-param.html">condition</a> is false.</p></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="require-param.html"><span class="token function">requireParam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">condition<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">lazyMessage<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Any///PointingToDeclaration/">Any</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Throws <a href="-invalid-parameter-exception/index.html">InvalidParameterException</a> with the result of calling <a href="require-param.html">lazyMessage</a> when <a href="require-param.html">condition</a> is false.</p></div></div></div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
     </div>
   </div>
 </div>
diff --git a/library/error/org.kotlincrypto.error/require-param.html b/library/error/org.kotlincrypto.error/require-param.html
@@ -0,0 +1,76 @@
+<!doctype html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>requireParam</title>
+<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">    <script>var pathToRoot = "../../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
+<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
+<link href="../../../styles/style.css" rel="Stylesheet">
+<link href="../../../styles/main.css" rel="Stylesheet">
+<link href="../../../styles/prism.css" rel="Stylesheet">
+<link href="../../../styles/logo-styles.css" rel="Stylesheet">
+<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
+<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
+<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
+<script type="text/javascript" src="../../../scripts/main.js" defer></script>
+<script type="text/javascript" src="../../../scripts/prism.js" async></script>
+<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
+<body>
+    <div class="root">
+<nav class="navigation" id="navigation-wrapper">
+    <div class="navigation--inner">
+        <div class="navigation-title">
+            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+            <div class="library-name">
+<a class="library-name--link" href="../../../index.html">
+                            error
+                    </a>            </div>
+            <div class="library-version">0.2.0
+            </div>
+        </div>
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector common-like" data-active="" data-filter=":library:error:dokkaHtmlPartial/commonMain">common</button>
+        </div>
+    </div>
+    <div class="navigation-controls">
+        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
+        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
+    </div>
+</nav>
+        <div id="container">
+            <div class="sidebar" id="leftColumn">
+                <div class="sidebar--inner" id="sideMenu"></div>
+            </div>
+            <div id="main">
+<div class="main-content" data-page-type="member" id="content" pageids="error::org.kotlincrypto.error//requireParam/#kotlin.Boolean/PointingToDeclaration//239568316">
+  <div class="breadcrumbs"><a href="../index.html">error</a><span class="delimiter">/</span><a href="index.html">org.kotlincrypto.error</a><span class="delimiter">/</span><span class="current">requireParam</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span>require</span><wbr><span><span>Param</span></span></h1>
+  </div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:error:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="require-param.html"><span class="token function">requireParam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">condition<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/KotlinCrypto/error/tree/master/library/error/src/commonMain/kotlin/org/kotlincrypto/error/Preconditions.kt#L27">source</a>)</span></span></div><p class="paragraph">Throws <a href="-invalid-parameter-exception/index.html">InvalidParameterException</a> when <a href="require-param.html">condition</a> is false.</p><hr><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><a href="require-param.html"><span class="token function">requireParam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">condition<span class="token operator">: </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">lazyMessage<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Any///PointingToDeclaration/">Any</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/KotlinCrypto/error/tree/master/library/error/src/commonMain/kotlin/org/kotlincrypto/error/Preconditions.kt#L38">source</a>)</span></span></div><p class="paragraph">Throws <a href="-invalid-parameter-exception/index.html">InvalidParameterException</a> with the result of calling <a href="require-param.html">lazyMessage</a> when <a href="require-param.html">condition</a> is false.</p></div></div>
+</div>
+      <div class="footer">
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>
+            </div>
+        </div>
+    </div>
+</body>
+</html>
+
diff --git a/navigation.html b/navigation.html
diff --git a/scripts/pages.json b/scripts/pages.json
