summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNadia Barbosa <captainbarbosa@users.noreply.github.com>2018-02-06 18:43:18 -0500
committerNadia Barbosa <captainbarbosa@users.noreply.github.com>2018-02-06 18:43:18 -0500
commit51bd7697cce6590a75a0cffcf0618153e9a9f28d (patch)
tree1dacd5ae94a642576191a9d3d9564643435e472b
parent6fcdf33545ca260d194a3845f6437d54ececfb0c (diff)
downloadqtlocation-mapboxgl-51bd7697cce6590a75a0cffcf0618153e9a9f28d.tar.gz
First attempt at documentation
-rw-r--r--platform/ios/src/MGLPinAnnotationView.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/platform/ios/src/MGLPinAnnotationView.h b/platform/ios/src/MGLPinAnnotationView.h
index b916457644..734a203cd7 100644
--- a/platform/ios/src/MGLPinAnnotationView.h
+++ b/platform/ios/src/MGLPinAnnotationView.h
@@ -1,12 +1,24 @@
#import <Mapbox/Mapbox.h>
-MGL_EXPORT
+/**
+ The MGLPinAnnotation class defines a view-based annotation that conforms to the`MGLAnnotation` protocol. This class provides initializers to create a pin-shaped annotation with customizable colors.
+ */
+MGL_EXPORT
@interface MGLPinAnnotationView : MGLAnnotationView
+#pragma mark Configuring appearance
+
+/** A `UIColor` that defines the color of the pin's shadow. */
@property(nonatomic) UIColor *shadowColor;
+
+/** A `UIColor` that defines the pin's primary color. */
@property(nonatomic) UIColor *pinColor;
+
+/** A `UIColor` that defines the color of the pin's stroke outline. */
@property(nonatomic) UIColor *strokeColor;
+
+/** A `UIColor` that defines the color of the pin's inner circle. */
@property(nonatomic) UIColor *innerColor;
@end