Skip to content

Commit e4404f5

Browse files
authored
Add missing doc to geo-compose classes (#307)
1 parent b0bfd5a commit e4404f5

File tree

5 files changed

+25
-0
lines changed

5 files changed

+25
-0
lines changed

toolkit/geo-compose/src/main/java/com/arcgismaps/toolkit/geocompose/AnalysisOverlayCollection.kt

+5
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ public class AnalysisOverlayCollection : Iterable<AnalysisOverlay> {
4444
*/
4545
internal val changed: SharedFlow<ChangedEvent> = _changed.asSharedFlow()
4646

47+
/**
48+
* Returns an iterator over the elements in this collection
49+
*
50+
* @since 200.4.0
51+
*/
4752
override fun iterator(): Iterator<AnalysisOverlay> {
4853
return analysisOverlays.iterator()
4954
}

toolkit/geo-compose/src/main/java/com/arcgismaps/toolkit/geocompose/AttributionState.kt

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ import kotlinx.coroutines.launch
2727
/**
2828
* State holder for attribution bar related properties/events on the [com.arcgismaps.toolkit.geocompose.MapView].
2929
*
30+
* @property isAttributionBarVisible true if the attribution bar is visible in the GeoView, false otherwise
31+
* @property onAttributionTextChanged called when the attribution text for the data that is currently
32+
* displayed in the GeoView changes
33+
* @property onAttributionBarLayoutChanged called when the attribution bar's position or size changes
34+
* due to expanding, collapsing, or inset changes.
3035
* @since 200.4.0
3136
*/
3237
@Stable

toolkit/geo-compose/src/main/java/com/arcgismaps/toolkit/geocompose/GraphicsOverlayCollection.kt

+5
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ public class GraphicsOverlayCollection : Iterable<GraphicsOverlay> {
4848
*/
4949
internal val changed: SharedFlow<ChangedEvent> = _changed.asSharedFlow()
5050

51+
/**
52+
* Returns an iterator over the elements in this collection
53+
*
54+
* @since 200.4.0
55+
*/
5156
override fun iterator(): Iterator<GraphicsOverlay> {
5257
return graphicsOverlays.iterator()
5358
}

toolkit/geo-compose/src/main/java/com/arcgismaps/toolkit/geocompose/ImageOverlayCollection.kt

+5
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ public class ImageOverlayCollection : Iterable<ImageOverlay> {
4444
*/
4545
internal val changed: SharedFlow<ChangedEvent> = _changed.asSharedFlow()
4646

47+
/**
48+
* Returns an iterator over the elements in this collection
49+
*
50+
* @since 200.4.0
51+
*/
4752
override fun iterator(): Iterator<ImageOverlay> {
4853
return imageOverlays.iterator()
4954
}

toolkit/geo-compose/src/main/java/com/arcgismaps/toolkit/geocompose/ViewpointChangedState.kt

+5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ import com.arcgismaps.mapping.view.GeoView
3535
* @see rememberViewpointChangedStateForCenterAndScale
3636
* @see rememberViewpointChangedStateForBoundingGeometry
3737
* @see rememberViewpointChangedState
38+
*
39+
* @property onViewpointChangedForCenterAndScale called when the viewpoint changes, passing a viewpoint
40+
* type of [ViewpointType.CenterAndScale]
41+
* @property onViewpointChangedForBoundingGeometry called when the viewpoint changes, passing a viewpoint
42+
* type of [ViewpointType.BoundingGeometry]
3843
* @since 200.4.0
3944
*/
4045
@Stable

0 commit comments

Comments
 (0)