Skip to content

Commit d210d44

Browse files
committed
Add some more doc comments
1 parent e0020ed commit d210d44

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

Sources/StaticMap/MapAnnotation.swift

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@ import Utils
44

55
/// A marker to be drawn on a static map.
66
public indirect enum MapAnnotation {
7+
/// A circle of the given radius.
78
case circle(coords: Coordinates, radius: Double)
9+
/// A pin marker.
810
case pin(coords: Coordinates)
911

12+
/// A modifier attaching the given label.
1013
case label(annotation: MapAnnotation, text: String, padding: Double)
14+
/// A modifier setting the font size.
1115
case fontSize(annotation: MapAnnotation, size: Double)
16+
/// A modifier setting the color.
1217
case color(annotation: MapAnnotation, color: Color)
1318

1419
/// The center coordinates of the marked location.

Sources/StaticMap/StaticMap.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ public struct StaticMap {
2424
/// - padding: The padding on the x and y axis in pixels
2525
/// - zoom: The zoom level
2626
/// - center: The center of the map as a geographical location
27+
/// - span: The span of the map region to display
2728
/// - tileProvider: The OpenStreetMap tile provider to use
2829
/// - tileSize: The tile size in pixels
30+
/// - annotations: Annotations to render on top of the map
2931
public init(
3032
size: Vec2<Int> = .init(both: 300),
3133
padding: Vec2<Int> = .zero(),

0 commit comments

Comments
 (0)