Skip to content

Commit

Permalink
docs: Update docs (#1275)
Browse files Browse the repository at this point in the history
  • Loading branch information
googlemaps-bot authored Dec 9, 2023
1 parent 301f93a commit 2c3f13e
Show file tree
Hide file tree
Showing 57 changed files with 2,915 additions and 2,828 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<div class="breadcrumbs"><a href="../../../index.html">android-maps-utils </a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.algo</a><span class="delimiter">/</span><span class="current">AbstractAlgorithm</span></div>
<div class="cover ">
<h1 class="cover"><span>Abstract</span><wbr></wbr><span><span>Algorithm</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">class </span><a href="index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-algorithm/index.html">Algorithm</a><span class="token operator">&lt;</span><a href="../-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">Base Algorithm class that implements lock/unlock functionality.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-grid-based-algorithm/index.html">GridBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-pre-caching-algorithm-decorator/index.html">PreCachingAlgorithmDecorator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm-adapter/index.html">ScreenBasedAlgorithmAdapter</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-distance-based-algorithm/index.html">NonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">class </span><a href="index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-algorithm/index.html">Algorithm</a><span class="token operator">&lt;</span><a href="../-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">Base Algorithm class that implements lock/unlock functionality.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-grid-based-algorithm/index.html">GridBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-distance-based-algorithm/index.html">NonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm-adapter/index.html">ScreenBasedAlgorithmAdapter</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-pre-caching-algorithm-decorator/index.html">PreCachingAlgorithmDecorator</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<div class="breadcrumbs"><a href="../../../index.html">android-maps-utils </a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.view</a><span class="delimiter">/</span><span class="current">ClusterRenderer</span></div>
<div class="cover ">
<h1 class="cover"><span>Cluster</span><wbr></wbr><span><span>Renderer</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">ClusterRenderer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Renders clusters.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-advanced-markers-cluster-renderer/index.html">DefaultAdvancedMarkersClusterRenderer</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-cluster-renderer/index.html">DefaultClusterRenderer</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">ClusterRenderer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Renders clusters.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-cluster-renderer/index.html">DefaultClusterRenderer</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-advanced-markers-cluster-renderer/index.html">DefaultAdvancedMarkersClusterRenderer</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,13 @@ <h2 class="">Functions</h2>
<div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../../-marker-manager/-collection/index.html#-2102406451%2FFunctions%2F-1887420133"><span><span>clear</span></span></a></div>
<div><a href="../../-polygon-manager/-collection/index.html#-2102406451%2FFunctions%2F-1887420133"><span><span>clear</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2102406451%2FFunctions%2F-1887420133"></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:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../-marker-manager/-collection/index.html#-2102406451%2FFunctions%2F-1887420133"><span class="token function">clear</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../-polygon-manager/-collection/index.html#-2102406451%2FFunctions%2F-1887420133"><span class="token function">clear</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ <h2 class="">Functions</h2>
<div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../-marker-manager/index.html#122261785%2FFunctions%2F-1887420133"><span>get</span><wbr></wbr><span><span>Collection</span></span></a></div>
<div><a href="../-polygon-manager/index.html#122261785%2FFunctions%2F-1887420133"><span>get</span><wbr></wbr><span><span>Collection</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="122261785%2FFunctions%2F-1887420133"></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:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-marker-manager/index.html#122261785%2FFunctions%2F-1887420133"><span class="token function">getCollection</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(1)/">C</span></div><div class="brief ">Gets a named collection that was created by <a href="../-marker-manager/index.html#1200871055%2FFunctions%2F-1887420133">newCollection</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-polygon-manager/index.html#122261785%2FFunctions%2F-1887420133"><span class="token function">getCollection</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(1)/">C</span></div><div class="brief ">Gets a named collection that was created by <a href="../-polygon-manager/index.html#1200871055%2FFunctions%2F-1887420133">newCollection</a></div></div></div>
</div>
</div>
</div>
Expand All @@ -135,7 +135,7 @@ <h2 class="">Functions</h2>
</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:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="new-collection.html"><span class="token function">newCollection</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-collection/index.html">CircleManager.Collection</a></div><br><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-marker-manager/index.html#1200871055%2FFunctions%2F-1887420133"><span class="token function">newCollection</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(1)/">C</span></div><div class="brief ">Create a new named collection, which can later be looked up by <a href="../-marker-manager/index.html#122261785%2FFunctions%2F-1887420133">getCollection</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="new-collection.html"><span class="token function">newCollection</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-collection/index.html">CircleManager.Collection</a></div><br><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-polygon-manager/index.html#1200871055%2FFunctions%2F-1887420133"><span class="token function">newCollection</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(1)/">C</span></div><div class="brief ">Create a new named collection, which can later be looked up by <a href="../-polygon-manager/index.html#122261785%2FFunctions%2F-1887420133">getCollection</a></div></div></div>
</div>
</div>
</div>
Expand All @@ -159,13 +159,13 @@ <h2 class="">Functions</h2>
<div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../-marker-manager/index.html#1229539183%2FFunctions%2F-1887420133"><span><span>remove</span></span></a></div>
<div><a href="../-polygon-manager/index.html#1229539183%2FFunctions%2F-1887420133"><span><span>remove</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1229539183%2FFunctions%2F-1887420133"></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:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-marker-manager/index.html#1229539183%2FFunctions%2F-1887420133"><span class="token function">remove</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">object<span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(0)/">O</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief ">Removes an object from its collection.</div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-polygon-manager/index.html#1229539183%2FFunctions%2F-1887420133"><span class="token function">remove</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">object<span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.collections/MapObjectManager///PointingToGenericParameters(0)/">O</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief ">Removes an object from its collection.</div></div></div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 2c3f13e

Please sign in to comment.