docs: Add new modules to full scaladoc

Iltotore · Jul 13, 2021 · 71a79db · 71a79db
1 parent 2815c36
commit 71a79db
Show file tree

Hide file tree

Showing 66 changed files with 895 additions and 62 deletions.
diff --git a/build.sc b/build.sc
@@ -48,7 +48,10 @@ object main extends ScalaModule with PublishModule {
   def docSources = T.sources(pwd / "extra")
 
   def scaladocFiles = T {
-    os.walk(compile().classes.path) ++ os.walk(numeric.compile().classes.path)
+    os.walk(compile().classes.path) ++
+      os.walk(numeric.compile().classes.path) ++
+      os.walk(string.compile().classes.path) ++
+      os.walk(iterable.compile().classes.path)
   }
 
   //Rewrite of Mill's docJar to support custom scaladoc source

diff --git a/docs/scaladoc/api/index.html b/docs/scaladoc/api/index.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron.html b/docs/scaladoc/api/io/github/iltotore/iron.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/Constrained$.html b/docs/scaladoc/api/io/github/iltotore/iron/Constrained$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/Main$$DummyCompileTime.html b/docs/scaladoc/api/io/github/iltotore/iron/Main$$DummyCompileTime.html
@@ -0,0 +1,19 @@
+<html><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><title>DummyCompileTime</title><link rel="shortcut icon" type="image/x-icon" href="../../../../../favicon.ico"></link><script type="text/javascript" src="../../../../../scripts/searchData.js" defer="true"></script><link rel="stylesheet" href="../../../../../styles/nord-light.css"></link><link rel="stylesheet" href="../../../../../styles/scalastyle.css"></link><link rel="stylesheet" href="../../../../../styles/dotty-icons.css"></link><link rel="stylesheet" href="../../../../../styles/diagram.css"></link><link rel="stylesheet" href="../../../../../styles/filter-bar.css"></link><link rel="stylesheet" href="../../../../../styles/search-bar.css"></link><link rel="stylesheet" href="../../../../../styles/scaladoc-searchbar.css"></link><script type="text/javascript" src="../../../../../hljs/highlight.pack.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/hljs-scala3.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/ux.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/common/component.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/common/utils.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/components/FilterBar.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/components/DocumentableList.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/components/Input.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/components/FilterGroup.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/components/Filter.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/searchbar.js" defer="true"></script><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script><script type="text/javascript" src="https://d3js.org/d3.v6.min.js" defer="true"></script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/graphlib-dot.min.js" defer="true"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js" defer="true"></script><script type="text/javascript" src="../../../../../scripts/data.js" defer="true"></script><script>var pathToRoot = "../../../../../";</script></head><body><div id="container"><div id="leftColumn"><div id="logo"><span><div class="projectName">iron</div></span><span></span><div class="socials"></div></div><div id="paneSearch"></div><nav id="sideMenu2"><div class="expanded"><a href="#" class="selected expanded">iron</a><span class="ar"></span><div><a href="../../../../../index.html">index</a></div><div class="expanded"><a href="../../../../index.html">API</a><span class="ar"></span><div class="expanded"><a href="../iron.html"><span class="micon p"></span>io.github.iltotore.iron</a><span class="ar"></span><div><a href="Constrained$.html"><span class="micon o"></span>Constrained</a></div><div class="expanded"><a href="Main$.html"><span class="micon o"></span>Main</a><span class="ar"></span><div><a href="Main$$DummyCompileTime.html" class="selected expanded"><span class="micon t"></span>DummyCompileTime</a></div><div><a href="Main$$given_CompileTimeOnly_Boolean_DummyCompileTime$.html"><span class="micon g"></span>given_CompileTimeOnly_Boolean_DummyCompileTime</a></div><div><a href="Main$$DummyRuntime.html"><span class="micon t"></span>DummyRuntime</a></div><div><a href="Main$$given_RuntimeOnly_Boolean_DummyRuntime$.html"><span class="micon g"></span>given_RuntimeOnly_Boolean_DummyRuntime</a></div></div><div><a href="compileTime$.html"><span class="micon o"></span>compileTime</a></div><div><a href="testMain.html"><span class="micon c"></span>testMain</a></div></div><div><a href="constraint.html"><span class="micon p"></span>io.github.iltotore.iron.constraint</a><span class="ar"></span><div><a href="constraint/And.html"><span class="micon t"></span>And</a></div><div><a href="constraint/AndConstraint.html"><span class="micon c"></span>AndConstraint</a></div><div><a href="constraint/Constraint.html"><span class="micon t"></span>Constraint</a></div><div><a href="constraint/Constraint$.html"><span class="micon o"></span>Constraint</a><span class="ar"></span><div><a href="constraint/Constraint$$RuntimeOnly.html"><span class="micon t"></span>RuntimeOnly</a></div><div><a href="constraint/Constraint$$CompileTimeOnly.html"><span class="micon t"></span>CompileTimeOnly</a></div></div><div><a href="constraint/Equal.html"><span class="micon t"></span>Equal</a></div><div><a href="constraint/EqualConstraint.html"><span class="micon c"></span>EqualConstraint</a></div><div><a href="constraint/IllegalValueError.html"><span class="micon c"></span>IllegalValueError</a></div><div><a href="constraint/Not.html"><span class="micon t"></span>Not</a></div><div><a href="constraint/NotConstraint.html"><span class="micon c"></span>NotConstraint</a></div><div><a href="constraint/Or.html"><span class="micon t"></span>Or</a></div><div><a href="constraint/OrConstraint.html"><span class="micon c"></span>OrConstraint</a></div><div><a href="constraint/StrictEqual.html"><span class="micon t"></span>StrictEqual</a></div><div><a href="constraint/StrictEqualConstraint.html"><span class="micon c"></span>StrictEqualConstraint</a></div></div><div><a href="iterable.html"><span class="micon p"></span>io.github.iltotore.iron.iterable</a><span class="ar"></span><div><a href="iterable/constraint$.html"><span class="micon o"></span>constraint</a><span class="ar"></span><div><a href="iterable/constraint$$MinSize.html"><span class="micon t"></span>MinSize</a></div><div><a href="iterable/constraint$$given_RuntimeOnly_A_MinSize.html"><span class="micon g"></span>given_RuntimeOnly_A_MinSize</a></div><div><a href="iterable/constraint$$MaxSize.html"><span class="micon t"></span>MaxSize</a></div><div><a href="iterable/constraint$$given_RuntimeOnly_A_MaxSize.html"><span class="micon g"></span>given_RuntimeOnly_A_MaxSize</a></div><div><a href="iterable/constraint$$Size.html"><span class="micon t"></span>Size</a></div><div><a href="iterable/constraint$$given_RuntimeOnly_A_Size.html"><span class="micon g"></span>given_RuntimeOnly_A_Size</a></div><div><a href="iterable/constraint$$Contains.html"><span class="micon t"></span>Contains</a></div><div><a href="iterable/constraint$$given_RuntimeOnly_A_Contains.html"><span class="micon g"></span>given_RuntimeOnly_A_Contains</a></div></div></div><div><a href="numeric.html"><span class="micon p"></span>io.github.iltotore.iron.numeric</a><span class="ar"></span><div><a href="numeric/Main$.html"><span class="micon o"></span>Main</a></div><div><a href="numeric/NumberOrdering$.html"><span class="micon o"></span>NumberOrdering</a></div><div><a href="numeric/constraint$.html"><span class="micon o"></span>constraint</a><span class="ar"></span><div><a href="numeric/constraint$$Less.html"><span class="micon t"></span>Less</a></div><div><a href="numeric/constraint$$LessConstraint.html"><span class="micon c"></span>LessConstraint</a></div><div><a href="numeric/constraint$$LessEqual.html"><span class="micon t"></span>LessEqual</a></div><div><a href="numeric/constraint$$LessEqualConstraint.html"><span class="micon c"></span>LessEqualConstraint</a></div><div><a href="numeric/constraint$$Greater.html"><span class="micon t"></span>Greater</a></div><div><a href="numeric/constraint$$GreaterConstraint.html"><span class="micon c"></span>GreaterConstraint</a></div><div><a href="numeric/constraint$$GreaterEqual.html"><span class="micon t"></span>GreaterEqual</a></div><div><a href="numeric/constraint$$GreaterEqualConstraint.html"><span class="micon c"></span>GreaterEqualConstraint</a></div><div><a href="numeric/constraint$$Divisible.html"><span class="micon t"></span>Divisible</a></div><div><a href="numeric/constraint$$DivisibleConstraint.html"><span class="micon c"></span>DivisibleConstraint</a></div></div><div><a href="numeric/test.html"><span class="micon c"></span>test</a></div></div><div><a href="ordering.html"><span class="micon p"></span>io.github.iltotore.iron.ordering</a><span class="ar"></span><div><a href="ordering/InlinedOrdering.html"><span class="micon t"></span>InlinedOrdering</a></div><div><a href="ordering/InlinedOrdering$.html"><span class="micon o"></span>InlinedOrdering</a><span class="ar"></span><div><a href="ordering/InlinedOrdering$$given_Ordering_T.html"><span class="micon g"></span>given_Ordering_T</a></div></div></div><div><a href="string.html"><span class="micon p"></span>io.github.iltotore.iron.string</a><span class="ar"></span><div><a href="string/constraint$.html"><span class="micon o"></span>constraint</a><span class="ar"></span><div><a href="string/constraint$$LowerCase.html"><span class="micon t"></span>LowerCase</a></div><div><a href="string/constraint$$given_RuntimeOnly_String_LowerCase$.html"><span class="micon g"></span>given_RuntimeOnly_String_LowerCase</a></div><div><a href="string/constraint$$UpperCase.html"><span class="micon t"></span>UpperCase</a></div><div><a href="string/constraint$$given_RuntimeOnly_String_UpperCase$.html"><span class="micon g"></span>given_RuntimeOnly_String_UpperCase</a></div><div><a href="string/constraint$$Match.html"><span class="micon t"></span>Match</a></div><div><a href="string/constraint$$given_RuntimeOnly_String_Match.html"><span class="micon g"></span>given_RuntimeOnly_String_Match</a></div></div></div></div></div></nav></div><div id="main"><div id="leftToggler"><span class="icon-toggler"></span></div><div id="scaladoc-searchBar"></div><main><div id="content"><div class="breadcrumbs"><a href="#">iron</a>/<a href="../../../../index.html">API</a>/<a href="../iron.html">io.github.iltotore.iron</a>/<a href="Main$.html">Main</a>/<a href="Main$$DummyCompileTime.html">DummyCompileTime</a></div><div><div><div class="cover-header"><span class="micon t"></span><h1>DummyCompileTime</h1></div><div class="signature monospace"><span class="annotations monospace"></span><span class="modifiers"><span class="other-modifiers"> </span><span class="kind">trait </span></span><a href="Main$$DummyCompileTime.html" class="documentableName ">DummyCompileTime</a><span class="signature"></span></div><div class="documentableBrief doc"></div><div class="cover"><div class="doc"></div><dl class="attributes"></dl></div><div class="tabs single"><div class="names"><button data-togglable="graph" class="tab showGraph">Graph</button><button data-togglable="supertypes" class="tab ">Supertypes</button></div><div class="contents"><div data-togglable="graph" class="tab showGraph"><div id="inheritance-diagram" class="diagram-class showGraph"><input value="Reset zoom" type="button" class="btn" onclick="zoomOut()"></input><svg id="graph"></svg><script type="text/dot" id="dot"> digraph g {
+ node0 [id=node0, label="<span style=\"color: #FFFFFF;\">trait <a href=\"Main$$DummyCompileTime.html\">DummyCompileTime</a></span>", style="fill: #1CAACF;"];
+node1 [id=node1, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\">Object</span></span>", style="fill: #45AD7D;"];
+node2 [id=node2, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\">Any</span></span>", style="fill: #45AD7D;"];
+node3 [id=node3, label="<span style=\"color: #FFFFFF;\">trait <span data-unresolved-link=\"\">Matchable</span></span>", style="fill: #1CAACF;"];
+
+
+ node0 -> node1;
+node1 -> node2;
+node1 -> node3;
+node3 -> node2;
+
+}
+</script></div></div><div data-togglable="supertypes" class="tab "><div class="symbol monospace"><div>class <span data-unresolved-link="">Object</span></div><div>trait <span data-unresolved-link="">Matchable</span></div><div>class <span data-unresolved-link="">Any</span></div></div></div></div></div><div class="documentableFilter"><div class="filterUpperContainer"><button class="filterToggleButton" data-test-id="filterToggleButton">
+          <svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
+            <path d="M0 0h24v24H0z" fill="none"/>
+            <path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"/>
+          </svg>
+        </button><input class="filterableInput" placeholder="Filter all members" data-test-id="filterBarInput"></input></div><div class="filterLowerContainer"></div></div><div class="membersList"></div></div></div></div></main><footer><span class="go-to-top-icon"><a href="#container"><span class="icon-vertical_align_top"></span>&nbsp;Back to top</a></span><div class="socials"></div><div id="generated-by">Generated by&nbsp;<a href="https://github.com/lampepfl/dotty/tree/master/scaladoc"><img src="../../../../../images/scaladoc_logo.svg" alt="scaladoc" class="scaladoc_logo"></img></a></div></footer></div></div></body></html>