[ios, macos] Add snapshotter header example.

1 files changed, 20 insertions, 0 deletions

diff --git a/platform/darwin/src/MGLMapSnapshotter.h b/platform/darwin/src/MGLMapSnapshotter.h
index be4258e0ad..615d39bee4 100644
--- a/platform/darwin/src/MGLMapSnapshotter.h
+++ b/platform/darwin/src/MGLMapSnapshotter.h
@@ -89,6 +89,26 @@ typedef void (^MGLMapSnapshotCompletionHandler)(NSImage* _Nullable snapshot, NSE
 
 /**
  An immutable utility object for capturing map-based images.
+ 
+ ### Example
+ 
+ ```swift
+ var camera = MGLMapCamera()
+ camera.centerCoordinate = CLLocationCoordinate2D(latitude: 37.7184, longitude: -122.4365)
+ camera.pitch = 20
+ 
+ var options = MGLMapSnapshotOptions(styleURL: MGLStyle.satelliteStreetsStyleURL(), camera: camera, size: CGSize(width: 320, height: 480))
+ options.zoomLevel = 10
+ 
+ var snapshotter = MGLMapSnapshotter(options: options)
+ snapshotter.start { (image, error) in
+   if error {
+     // error handler
+   } else {
+     // image handler
+   }
+ }
+ ```
  */
 MGL_EXPORT
 @interface MGLMapSnapshotter : NSObject