Skip to content

Commit 8eabbf1

Browse files
clojure-buildclojure-build
committed
Autodoc commit
1 parent e425d39 commit 8eabbf1

2 files changed

Lines changed: 48 additions & 22 deletions

File tree

‎api-index.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html>
22
<head>
33
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4-
<title>Index - core.cache 1.0.226-SNAPSHOT API documentation</title>
4+
<title>Index - core.cache 1.2.999-SNAPSHOT API documentation</title>
55
<link rel="icon" href="static/favicon.png" />
66
<link rel="shortcut icon" href="static/favicon.png" />
77
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
@@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.cache A
2525
<div id="leftcolumn"><div style="text-align: center;"></div>
2626
<div class="menu">
2727
<div class="WikiCustomNav WikiElement wiki">
28-
<span class="toc-header"><span id="project-name">core.cache</span> <span id="version">1.0.226-SNAPSHOT</span> API</span><br />
28+
<span class="toc-header"><span id="project-name">core.cache</span> <span id="version">1.2.999-SNAPSHOT</span> API</span><br />
2929
<ul>
3030
<li><a href="index.html" class="wiki_link">Overview</a></li>
3131
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
@@ -41,7 +41,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.cache A
4141
<div class="contentBox"><div class="innerContentBox">
4242
<div class="wiki wikiPage" id="content_view">
4343
<div id="right-sidebar"></div>
44-
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">core.cache</span> <span id="header-version">1.0.226-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
44+
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">core.cache</span> <span id="header-version">1.2.999-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
4545
This page has an alphabetical index of all the documented functions and variables
4646
in <span class="project-name-span">core.cache</span>.
4747

@@ -197,6 +197,7 @@ <h2 id="S"><span id="section-head">S</span></h2>
197197
<span id="section-content"> <a href="index.html#clojure.core.cache/-&gt;SoftCache">-&gt;SoftCache</a><span id="line-content"> function clojure.core.cache Positional factory function for class clojure.core...
198198
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/seed">seed</a><span id="line-content"> function clojure.core.cache Is used to signal that the cache should be created...
199199
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache.wrapped/seed">seed</a><span id="line-content"> function clojure.core.cache.wrapped Is used to signal that the cache should be...
200+
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache.wrapped/size">size</a><span id="line-content"> function clojure.core.cache.wrapped Obtain the approximate size/count of the w...
200201
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/soft-cache-factory">soft-cache-factory</a><span id="line-content"> function clojure.core.cache Returns a SoftReference cache. Cached values will...
201202
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache.wrapped/soft-cache-factory">soft-cache-factory</a><span id="line-content"> function clojure.core.cache.wrapped Returns a SoftReference cache. Cached val...
202203
</span></span><span id="section-content"> <a href="index.html#clojure.core.cache/SoftCache">SoftCache</a><span id="line-content"> type clojure.core.cache

‎index.html‎

Lines changed: 44 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html>
22
<head>
33
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4-
<title>clojure.core.cache - core.cache 1.0.226-SNAPSHOT API documentation</title>
4+
<title>clojure.core.cache - core.cache 1.2.999-SNAPSHOT API documentation</title>
55
<link rel="icon" href="static/favicon.png" />
66
<link rel="shortcut icon" href="static/favicon.png" />
77
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
@@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.cache A
2525
<div id="leftcolumn"><div style="text-align: center;"></div>
2626
<div class="menu">
2727
<div class="WikiCustomNav WikiElement wiki">
28-
<span class="toc-header"><span id="project-name">core.cache</span> <span id="version">1.0.226-SNAPSHOT</span> API</span><br />
28+
<span class="toc-header"><span id="project-name">core.cache</span> <span id="version">1.2.999-SNAPSHOT</span> API</span><br />
2929
<ul>
3030
<li><a href="index.html" class="wiki_link">Overview</a></li>
3131
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
@@ -185,6 +185,9 @@ <h1 class="nopad">Table of Contents</h1>
185185
</div><div class="toc-entry" style="margin-left: 1em;">
186186
<a href="#clojure.core.cache.wrapped/seed" class="toc-entry-anchor">seed</a>
187187

188+
</div><div class="toc-entry" style="margin-left: 1em;">
189+
<a href="#clojure.core.cache.wrapped/size" class="toc-entry-anchor">size</a>
190+
188191
</div><div class="toc-entry" style="margin-left: 1em;">
189192
<a href="#clojure.core.cache.wrapped/soft-cache-factory" class="toc-entry-anchor">soft-cache-factory</a>
190193

@@ -202,7 +205,7 @@ <h1 class="nopad">Table of Contents</h1>
202205
</div>
203206
</div>
204207
<div id="content-tag"><h1 id="overview">API for <span id="clojure.core.cache">clojure.core.cache</span>
205-
- <span id="header-project">core.cache</span> <span id="header-version">1.0.226-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
208+
- <span id="header-project">core.cache</span> <span id="header-version">1.2.999-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
206209
</h1>
207210
<span id="author-line">by <span id="author-name">Fogus</span><br /></span>
208211
<br />Full namespace name: <span id="long-name">clojure.core.cache</span>
@@ -661,7 +664,7 @@ <h2 id="clojure.core.cache.wrapped/basic-cache-factory">basic-cache-factory</h2>
661664
<pre id="var-specs"></pre>
662665

663666

664-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L130">Source</a>
667+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L161">Source</a>
665668
</div><div id="var-entry">
666669
<br />
667670
<hr />
@@ -675,7 +678,7 @@ <h2 id="clojure.core.cache.wrapped/evict">evict</h2>
675678
<pre id="var-specs"></pre>
676679

677680

678-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L95">Source</a>
681+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L126">Source</a>
679682
</div><div id="var-entry">
680683
<br />
681684
<hr />
@@ -700,7 +703,7 @@ <h2 id="clojure.core.cache.wrapped/fifo-cache-factory">fifo-cache-factory</h2>
700703
<pre id="var-specs"></pre>
701704

702705

703-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L135">Source</a>
706+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L166">Source</a>
704707
</div><div id="var-entry">
705708
<br />
706709
<hr />
@@ -714,7 +717,7 @@ <h2 id="clojure.core.cache.wrapped/has?">has?</h2>
714717
<pre id="var-specs"></pre>
715718

716719

717-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L72">Source</a>
720+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L88">Source</a>
718721
</div><div id="var-entry">
719722
<br />
720723
<hr />
@@ -729,7 +732,7 @@ <h2 id="clojure.core.cache.wrapped/hit">hit</h2>
729732
<pre id="var-specs"></pre>
730733

731734

732-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L79">Source</a>
735+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L110">Source</a>
733736
</div><div id="var-entry">
734737
<br />
735738
<hr />
@@ -742,7 +745,7 @@ <h2 id="clojure.core.cache.wrapped/lirs-cache-factory">lirs-cache-factory</h2>
742745
<pre id="var-specs"></pre>
743746

744747

745-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L179">Source</a>
748+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L210">Source</a>
746749
</div><div id="var-entry">
747750
<br />
748751
<hr />
@@ -759,7 +762,7 @@ <h2 id="clojure.core.cache.wrapped/lookup">lookup</h2>
759762
<pre id="var-specs"></pre>
760763

761764

762-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L25">Source</a>
765+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L27">Source</a>
763766
</div><div id="var-entry">
764767
<br />
765768
<hr />
@@ -780,7 +783,7 @@ <h2 id="clojure.core.cache.wrapped/lookup-or-miss">lookup-or-miss</h2>
780783
<pre id="var-specs"></pre>
781784

782785

783-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L38">Source</a>
786+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L38">Source</a>
784787
</div><div id="var-entry">
785788
<br />
786789
<hr />
@@ -796,7 +799,7 @@ <h2 id="clojure.core.cache.wrapped/lru-cache-factory">lru-cache-factory</h2>
796799
<pre id="var-specs"></pre>
797800

798801

799-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L153">Source</a>
802+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L184">Source</a>
800803
</div><div id="var-entry">
801804
<br />
802805
<hr />
@@ -811,7 +814,7 @@ <h2 id="clojure.core.cache.wrapped/lu-cache-factory">lu-cache-factory</h2>
811814
<pre id="var-specs"></pre>
812815

813816

814-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L171">Source</a>
817+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L202">Source</a>
815818
</div><div id="var-entry">
816819
<br />
817820
<hr />
@@ -826,7 +829,7 @@ <h2 id="clojure.core.cache.wrapped/miss">miss</h2>
826829
<pre id="var-specs"></pre>
827830

828831

829-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L87">Source</a>
832+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L118">Source</a>
830833
</div><div id="var-entry">
831834
<br />
832835
<hr />
@@ -842,7 +845,29 @@ <h2 id="clojure.core.cache.wrapped/seed">seed</h2>
842845
<pre id="var-specs"></pre>
843846

844847

845-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L102">Source</a>
848+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L133">Source</a>
849+
</div><div id="var-entry">
850+
<br />
851+
<hr />
852+
<h2 id="clojure.core.cache.wrapped/size">size</h2>
853+
<span id="var-type">function</span><br />
854+
<pre id="var-usage">Usage: (size cache-atom)
855+
</pre>
856+
<pre id="var-docstr">Obtain the approximate size/count of the wrapped cache.
857+
858+
The value returned is a point-in-time approximate count/size as the nature
859+
of certain caches don't reflect their true size until a 'lookup-or-miss'
860+
operation is invoked - such as the TTL cache.
861+
862+
Whilst it is an approximate value, the returned result can be useful for
863+
metric tracking or decision making.
864+
865+
Returns an approximate count/size of the wrapped cache.
866+
</pre>
867+
<pre id="var-specs"></pre>
868+
869+
870+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L95">Source</a>
846871
</div><div id="var-entry">
847872
<br />
848873
<hr />
@@ -859,7 +884,7 @@ <h2 id="clojure.core.cache.wrapped/soft-cache-factory">soft-cache-factory</h2>
859884
<pre id="var-specs"></pre>
860885

861886

862-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L189">Source</a>
887+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L220">Source</a>
863888
</div><div id="var-entry">
864889
<br />
865890
<hr />
@@ -877,7 +902,7 @@ <h2 id="clojure.core.cache.wrapped/through">through</h2>
877902
<pre id="var-specs"></pre>
878903

879904

880-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L111">Source</a>
905+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L142">Source</a>
881906
</div><div id="var-entry">
882907
<br />
883908
<hr />
@@ -892,7 +917,7 @@ <h2 id="clojure.core.cache.wrapped/through-cache">through-cache</h2>
892917
<pre id="var-specs"></pre>
893918

894919

895-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L122">Source</a>
920+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L153">Source</a>
896921
</div><div id="var-entry">
897922
<br />
898923
<hr />
@@ -908,7 +933,7 @@ <h2 id="clojure.core.cache.wrapped/ttl-cache-factory">ttl-cache-factory</h2>
908933
<pre id="var-specs"></pre>
909934

910935

911-
<a id="var-source" href="https://github.com/clojure/core.cache/blob/9038e65b5d0d2c256c68740007e29ef115ac3ec6/src/main/clojure/clojure/core/cache/wrapped.clj#L162">Source</a>
936+
<a id="var-source" href="https://github.com/clojure/core.cache/blob/a6c423230321fcc5db24d8b988e5dd21202f6c64/src/main/clojure/clojure/core/cache/wrapped.clj#L193">Source</a>
912937
</div>
913938
</div>
914939

0 commit comments

Comments
 (0)