doc experiments

npryce · Apr 26, 2024 · 0f554cb · 0f554cb
1 parent 7945ee8
commit 0f554cb
Show file tree

Hide file tree

Showing 132 changed files with 12,206 additions and 0 deletions.
diff --git a/build.gradle b/build.gradle
@@ -2,6 +2,7 @@ plugins {
     id "org.jetbrains.kotlin.jvm" version "1.4.10"
     id 'maven'
     id 'signing'
+    id("org.jetbrains.dokka") version "1.9.20"
 }
 
 group 'com.natpryce'
@@ -70,6 +71,10 @@ signing {
     sign configurations.archives
 }
 
+tasks.dokkaHtml {
+    outputDirectory.set(layout.projectDirectory.dir("docs/html"))
+}
+
 task ossrhAuthentication {
     doFirst {
         if (!(project.hasProperty('ossrh.username') && project.hasProperty('ossrh.password'))) {

diff --git a/docs/html/hamkrest/com.natpryce.hamkrest.assertion/assert-that.html b/docs/html/hamkrest/com.natpryce.hamkrest.assertion/assert-that.html
@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>assertThat</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="async"></script>
+<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="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="async"></script>
+<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
+<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="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">
+                            hamkrest
+                    </a>
+            </div>
+            <div class="library-version">
+SNAPSHOT            </div>
+        </div>
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</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="hamkrest::com.natpryce.hamkrest.assertion//assertThat/#TypeParam(bounds=[kotlin.Any?])#com.natpryce.hamkrest.Matcher[TypeParam(bounds=[kotlin.Any?])]#kotlin.Function0[kotlin.String]/PointingToDeclaration//769193423">
+  <div class="breadcrumbs"><a href="../../index.html">hamkrest</a><span class="delimiter">/</span><a href="index.html">com.natpryce.hamkrest.assertion</a><span class="delimiter">/</span><span class="current">assertThat</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span>assert</span><wbr></wbr><span><span>That</span></span></h1>
+  </div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><a href="../com.natpryce.hamkrest/-matcher/index.html">Matcher</a><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">message<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/String///PointingToDeclaration/">String</span><span class="token operator"> = </span>::noMessage</span></span><span class="token punctuation">)</span></div><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><span class="token punctuation">(</span><a href="assert-that.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">message<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/String///PointingToDeclaration/">String</span><span class="token operator"> = </span>::noMessage</span></span><span class="token punctuation">)</span></div><p class="paragraph">Asserts that <a href="assert-that.html">criteria</a> matches <a href="assert-that.html">actual</a>. On failure, the diagnostic is prefixed with the result of calling <a href="assert-that.html">message</a>.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="kotlin/AssertionError///PointingToDeclaration/"><span>Assertion</span><wbr></wbr><span><span>Error</span></span></span></div></span></div><div><div class="title"><p class="paragraph">if there is a mismatch</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token punctuation">, </span><a href="assert-that.html">U</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><span class="token punctuation">(</span><a href="assert-that.html">T</a><span class="token punctuation">, </span><a href="assert-that.html">U</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">other<span class="token operator">: </span><a href="assert-that.html">U</a><span class="token punctuation">, </span></span><span class="parameter ">message<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/String///PointingToDeclaration/">String</span><span class="token operator"> = </span>::noMessage</span></span><span class="token punctuation">)</span></div><p class="paragraph">Asserts that <a href="assert-that.html">criteria</a>(<a href="assert-that.html">actual</a>, <a href="assert-that.html">other</a>) returns true. On failure, the diagnostic is prefixed with the result of calling <a href="assert-that.html">message</a>.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="kotlin/AssertionError///PointingToDeclaration/"><span>Assertion</span><wbr></wbr><span><span>Error</span></span></span></div></span></div><div><div class="title"><p class="paragraph">if there is a mismatch</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><span data-unresolved-link="kotlin/String///PointingToDeclaration/">String</span><span class="token punctuation">, </span></span><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><a href="../com.natpryce.hamkrest/-matcher/index.html">Matcher</a><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Asserts that <a href="assert-that.html">criteria</a> matches <a href="assert-that.html">actual</a>.  On failure, the diagnostic is prefixed with <a href="assert-that.html">message</a>.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="kotlin/AssertionError///PointingToDeclaration/"><span>Assertion</span><wbr></wbr><span><span>Error</span></span></span></div></span></div><div><div class="title"><p class="paragraph">if there is a mismatch</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><span data-unresolved-link="kotlin/String///PointingToDeclaration/">String</span><span class="token punctuation">, </span></span><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><span class="token punctuation">(</span><a href="assert-that.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Asserts that <a href="assert-that.html">criteria</a> returns true for <a href="assert-that.html">actual</a>.  On failure, the diagnostic is prefixed with <a href="assert-that.html">message</a>.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="kotlin/AssertionError///PointingToDeclaration/"><span>Assertion</span><wbr></wbr><span><span>Error</span></span></span></div></span></div><div><div class="title"><p class="paragraph">if there is a mismatch</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="assert-that.html">T</a><span class="token punctuation">, </span><a href="assert-that.html">U</a><span class="token operator">&gt; </span><a href="assert-that.html"><span class="token function">assertThat</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><span data-unresolved-link="kotlin/String///PointingToDeclaration/">String</span><span class="token punctuation">, </span></span><span class="parameter ">actual<span class="token operator">: </span><a href="assert-that.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">criteria<span class="token operator">: </span><span class="token punctuation">(</span><a href="assert-that.html">T</a><span class="token punctuation">, </span><a href="assert-that.html">U</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span data-unresolved-link="kotlin/Boolean///PointingToDeclaration/">Boolean</span><span class="token punctuation">, </span></span><span class="parameter ">other<span class="token operator">: </span><a href="assert-that.html">U</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Asserts that <a href="assert-that.html">criteria</a>(<a href="assert-that.html">actual</a>, <a href="assert-that.html">other</a>) returns true.  On failure, the diagnostic is prefixed with <a href="assert-that.html">message</a>.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><span data-unresolved-link="kotlin/AssertionError///PointingToDeclaration/"><span>Assertion</span><wbr></wbr><span><span>Error</span></span></span></div></span></div><div><div class="title"><p class="paragraph">if there is a mismatch</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>© 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>
+            </div>
+        </div>
+    </div>
+</body>
+</html>