docs: Update docs (#662)

googlemaps · Jan 3, 2025 · 1e5f502 · 1e5f502
1 parent 99d7e6f
commit 1e5f502
Show file tree

Hide file tree

Showing 158 changed files with 316 additions and 316 deletions.
diff --git a/index.html b/index.html
@@ -44,7 +44,7 @@
                     </a>
             </div>
             <div class="library-version">
-6.3.0            </div>
+6.4.0            </div>
         </div>
     </div>
     <div class="navigation-controls">
@@ -98,7 +98,7 @@ <h2 class="">All modules:</h2>
   </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
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-utils/com.google.maps.android.compose.clustering/-clustering.html b/maps-compose-utils/com.google.maps.android.compose.clustering/-clustering.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -85,7 +85,7 @@ <h1 class="cover"><span><span>Clustering</span></span></h1>
         </code></pre><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><p class="paragraph">Groups many items on a map based on zoom level.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>items</span></span></u></div></span></div><div><div class="title"><p class="paragraph">all items to show</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Cluster</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a lambda invoked when the user clicks a cluster of items</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Cluster</span><wbr><span>Item</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a lambda invoked when the user clicks a non-clustered item</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Cluster</span><wbr><span>Item</span><wbr><span>Info</span><wbr><span>Window</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a lambda invoked when the user clicks the info window of a non-clustered item</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Cluster</span><wbr><span>Item</span><wbr><span>Info</span><wbr><span>Window</span><wbr><span>Long</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a lambda invoked when the user long-clicks the info window of a non-clustered item</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>cluster</span><wbr><span><span>Content</span></span></u></div></span></div><div><div class="title"><p class="paragraph">an optional Composable that is rendered for each <span data-unresolved-link="com.google.maps.android.clustering/Cluster///PointingToDeclaration/">Cluster</span>.</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>cluster</span><wbr><span>Item</span><wbr><span><span>Content</span></span></u></div></span></div><div><div class="title"><p class="paragraph">an optional Composable that is rendered for each non-clustered item.</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>cluster</span><wbr><span><span>Renderer</span></span></u></div></span></div><div><div class="title"><p class="paragraph">an optional ClusterRenderer that can be used to specify the algorithm used by the rendering.</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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-utils/com.google.maps.android.compose.clustering/index.html b/maps-compose-utils/com.google.maps.android.compose.clustering/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -119,7 +119,7 @@ <h2 class="">Functions</h2>
   </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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-utils/com.google.maps.android.compose.clustering/remember-cluster-manager.html b/maps-compose-utils/com.google.maps.android.compose.clustering/remember-cluster-manager.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -66,7 +66,7 @@ <h1 class="cover"><span>remember</span><wbr><span>Cluster</span><wbr><span><span
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":maps-compose-utils:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div><div class="block"><span class="token annotation builtin">@</span><a href="../../maps-compose/com.google.maps.android.compose/-maps-compose-experimental-api/index.html"><span class="token annotation builtin">MapsComposeExperimentalApi</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="remember-cluster-manager.html">T</a><span class="token operator"> : </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterItem///PointingToDeclaration/">ClusterItem</span><span class="token operator">&gt; </span><a href="remember-cluster-manager.html"><span class="token function">rememberClusterManager</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterManager///PointingToDeclaration/">ClusterManager</span><span class="token operator">&lt;</span><a href="remember-cluster-manager.html">T</a><span class="token operator">&gt;</span><span class="token operator">?</span></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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-utils/com.google.maps.android.compose.clustering/remember-cluster-renderer.html b/maps-compose-utils/com.google.maps.android.compose.clustering/remember-cluster-renderer.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -66,7 +66,7 @@ <h1 class="cover"><span>remember</span><wbr><span>Cluster</span><wbr><span><span
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":maps-compose-utils:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div><div class="block"><span class="token annotation builtin">@</span><a href="../../maps-compose/com.google.maps.android.compose/-maps-compose-experimental-api/index.html"><span class="token annotation builtin">MapsComposeExperimentalApi</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator"> : </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterItem///PointingToDeclaration/">ClusterItem</span><span class="token operator">&gt; </span><a href="remember-cluster-renderer.html"><span class="token function">rememberClusterRenderer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">clusterManager<span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterManager///PointingToDeclaration/">ClusterManager</span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.clustering.view/ClusterRenderer///PointingToDeclaration/">ClusterRenderer</span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator">&gt;</span><span class="token operator">?</span></div><br><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div><div class="block"><span class="token annotation builtin">@</span><a href="../../maps-compose/com.google.maps.android.compose/-maps-compose-experimental-api/index.html"><span class="token annotation builtin">MapsComposeExperimentalApi</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator"> : </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterItem///PointingToDeclaration/">ClusterItem</span><span class="token operator">&gt; </span><a href="remember-cluster-renderer.html"><span class="token function">rememberClusterRenderer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">clusterContent<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><span data-unresolved-link="com.google.maps.android.clustering/Cluster///PointingToDeclaration/">Cluster</span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter ">clusterItemContent<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><a href="remember-cluster-renderer.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter ">clusterManager<span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.clustering/ClusterManager///PointingToDeclaration/">ClusterManager</span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.google.maps.android.clustering.view/ClusterRenderer///PointingToDeclaration/">ClusterRenderer</span><span class="token operator">&lt;</span><a href="remember-cluster-renderer.html">T</a><span class="token operator">&gt;</span><span class="token operator">?</span></div><p class="paragraph">Default Renderer for drawing Composable.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>cluster</span><wbr><span><span>Content</span></span></u></div></span></div><div><div class="title"><p class="paragraph">an optional Composable that is rendered for each <span data-unresolved-link="com.google.maps.android.clustering/Cluster///PointingToDeclaration/">Cluster</span>.</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose-utils:dokkaHtmlPartial/release" data-filterable-set=":maps-compose-utils:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>cluster</span><wbr><span>Item</span><wbr><span><span>Content</span></span></u></div></span></div><div><div class="title"><p class="paragraph">an optional Composable that is rendered for each non-clustered item.</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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-utils/index.html b/maps-compose-utils/index.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -85,7 +85,7 @@ <h2 class="">Packages</h2>
   </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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>

diff --git a/maps-compose-widgets/com.google.maps.android.compose.widgets/-dark-gray.html b/maps-compose-widgets/com.google.maps.android.compose.widgets/-dark-gray.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../index.html">
                             android-maps-compose
                     </a>            </div>
-            <div class="library-version">6.3.0
+            <div class="library-version">6.4.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -66,7 +66,7 @@ <h1 class="cover"><span>Dark</span><wbr><span><span>Gray</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":maps-compose-widgets:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="-dark-gray.html">DarkGray</a><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html">Color</a></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>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 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>