Skip to content

Commit 244fba9

Browse files
MSDarwish2000MSDarwish2000
committed
Add docs
1 parent cd6a22b commit 244fba9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+4659
-0
lines changed

‎docs/images/anchor-copy-button.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/images/arrow_down.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/copy-icon.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/copy-successful-icon.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/footer-go-to-link.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/go-to-top-icon.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/images/logo-icon.svg‎

Lines changed: 10 additions & 0 deletions
Loading

‎docs/images/theme-toggle.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/index.html‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>lrucache</title>
6+
<link href="images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
const savedDarkMode = storage ? JSON.parse(storage) : false
10+
if(savedDarkMode === true){
11+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
12+
}</script>
13+
<script type="text/javascript" src="scripts/sourceset_dependencies.js" async="async"></script>
14+
<link href="styles/style.css" rel="Stylesheet">
15+
<link href="styles/jetbrains-mono.css" rel="Stylesheet">
16+
<link href="styles/main.css" rel="Stylesheet">
17+
<link href="styles/prism.css" rel="Stylesheet">
18+
<link href="styles/logo-styles.css" rel="Stylesheet">
19+
<script type="text/javascript" src="scripts/clipboard.js" async="async"></script>
20+
<script type="text/javascript" src="scripts/navigation-loader.js" async="async"></script>
21+
<script type="text/javascript" src="scripts/platform-content-handler.js" async="async"></script>
22+
<script type="text/javascript" src="scripts/main.js" defer="defer"></script>
23+
<script type="text/javascript" src="scripts/prism.js" async="async"></script>
24+
</head>
25+
<body>
26+
<div class="navigation-wrapper" id="navigation-wrapper">
27+
<div id="leftToggler"><span class="icon-toggler"></span></div>
28+
<div class="library-name">
29+
<a href="index.html">
30+
<span>lrucache</span>
31+
</a>
32+
</div>
33+
<div>
34+
1.0.0 </div>
35+
<div class="pull-right d-flex">
36+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
37+
<div id="searchBar"></div>
38+
</div>
39+
</div>
40+
<div id="container">
41+
<div id="leftColumn">
42+
<div id="sideMenu"></div>
43+
</div>
44+
<div id="main">
45+
<div class="main-content" id="content" pageIds="lrucache::////PointingToDeclaration//-1775341542">
46+
<div class="breadcrumbs"></div>
47+
<div class="cover ">
48+
<h1 class="cover"><span><span>lrucache</span></span></h1>
49+
</div>
50+
<h2 class="">Packages</h2>
51+
<div class="table"><a data-name="2138541423%2FPackages%2F-1775341542" anchor-label="com.mayakapps.lrucache" id="2138541423%2FPackages%2F-1775341542" data-filterable-set=":lrucache:dokkaHtml/main"></a>
52+
<div class="table-row" data-filterable-current=":lrucache:dokkaHtml/main" data-filterable-set=":lrucache:dokkaHtml/main">
53+
<div>
54+
<div class="main-subrow ">
55+
<div class=""><span class="inline-flex">
56+
<div><a href="lrucache/com.mayakapps.lrucache/index.html">com.mayakapps.lrucache</a></div>
57+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2138541423%2FPackages%2F-1775341542"></span>
58+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
59+
</span></span></div>
60+
<div class="pull-right"></div>
61+
</div>
62+
<div></div>
63+
</div>
64+
</div>
65+
</div>
66+
</div>
67+
<div class="footer">
68+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
69+
class="pull-right"><span>Generated by </span><a
70+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
71+
</div>
72+
</div>
73+
</div>
74+
</body>
75+
</html>

‎docs/lrucache/com.mayakapps.lrucache/-disk-lru-cache/-companion/index.html‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Companion</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
const savedDarkMode = storage ? JSON.parse(storage) : false
10+
if(savedDarkMode === true){
11+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
12+
}</script>
13+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
14+
<link href="../../../../styles/style.css" rel="Stylesheet">
15+
<link href="../../../../styles/jetbrains-mono.css" rel="Stylesheet">
16+
<link href="../../../../styles/main.css" rel="Stylesheet">
17+
<link href="../../../../styles/prism.css" rel="Stylesheet">
18+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
19+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
20+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
21+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
22+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
23+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
24+
</head>
25+
<body>
26+
<div class="navigation-wrapper" id="navigation-wrapper">
27+
<div id="leftToggler"><span class="icon-toggler"></span></div>
28+
<div class="library-name">
29+
<a href="../../../../index.html">
30+
<span>lrucache</span>
31+
</a>
32+
</div>
33+
<div>
34+
1.0.0 </div>
35+
<div class="pull-right d-flex">
36+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
37+
<div id="searchBar"></div>
38+
</div>
39+
</div>
40+
<div id="container">
41+
<div id="leftColumn">
42+
<div id="sideMenu"></div>
43+
</div>
44+
<div id="main">
45+
<div class="main-content" id="content" pageIds="lrucache::com.mayakapps.lrucache/DiskLruCache.Companion///PointingToDeclaration//-1775341542">
46+
<div class="breadcrumbs"><a href="../../../../index.html">lrucache</a><span class="delimiter">/</span><a href="../../index.html">com.mayakapps.lrucache</a><span class="delimiter">/</span><a href="../index.html">DiskLruCache</a><span class="delimiter">/</span><a href="index.html">Companion</a></div>
47+
<div class="cover ">
48+
<h1 class="cover"><span><span>Companion</span></span></h1>
49+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":lrucache:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
50+
</div>
51+
<div class="tabbedcontent">
52+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
53+
<div class="tabs-section-body">
54+
<h2 class="">Functions</h2>
55+
<div class="table" data-togglable="Functions"><a data-name="-1988003846%2FFunctions%2F-1775341542" anchor-label="open" id="-1988003846%2FFunctions%2F-1775341542" data-filterable-set=":lrucache:dokkaHtml/main"></a>
56+
<div class="table-row" data-filterable-current=":lrucache:dokkaHtml/main" data-filterable-set=":lrucache:dokkaHtml/main">
57+
<div class="main-subrow keyValue ">
58+
<div class=""><span class="inline-flex">
59+
<div><a href="open.html"><span><span>open</span></span></a></div>
60+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1988003846%2FFunctions%2F-1775341542"></span>
61+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
62+
</span></span></div>
63+
<div>
64+
<div class="title">
65+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":lrucache:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="open.html"><span class="token function">open</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;directory<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;maxSize<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;creationScope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token operator"> = </span>CoroutineScope(Dispatchers.IO)<span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;keyTransformer<span class="token operator">: </span><a href="../../-key-transformer/index.html">KeyTransformer</a><span class="token operator">?</span><span class="token operator"> = </span>SHA256KeyHasher</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">DiskLruCache</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Opens the persisted Least Recently Used (LRU) cache in the provided directory or creates a new one if it doesn't already exist.</p></div></div></div>
66+
</div>
67+
</div>
68+
</div>
69+
</div>
70+
</div>
71+
</div>
72+
</div>
73+
</div>
74+
<div class="footer">
75+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
76+
class="pull-right"><span>Generated by </span><a
77+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
78+
</div>
79+
</div>
80+
</div>
81+
</body>
82+
</html>

0 commit comments

Comments
 (0)