Skip to content

Commit e3d6f57

Browse files
authored
Merge pull request #193 from mapzen/docs
Additional docs fixes
2 parents 87dd30a + 7037e6a commit e3d6f57

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/MapViewController.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import OnTheRoad
2727
/// Single Tap Gesture Delegate
2828
public protocol MapSingleTapGestureDelegate : class {
2929
/**
30-
Asks the delegate if the map should recognize this single tap and perform default functionality.
30+
Asks the delegate if the map should recognize this single tap and perform default functionality (which is nothing, currently).
3131

3232
- parameter controller: The MapViewController that wants to recognize the tap.
3333
- parameter recognizer: The recognizer that initially recognized the tap.
@@ -50,7 +50,7 @@ public protocol MapSingleTapGestureDelegate : class {
5050
/// Double Tap Gesture Delegate
5151
public protocol MapDoubleTapGestureDelegate : class {
5252
/**
53-
Asks the delegate if the map should recognize this double tap and perform default functionality.
53+
Asks the delegate if the map should recognize this double tap and perform default functionality (which is nothing, currently).
5454

5555
- parameter controller: The MapViewController that wants to recognize the tap.
5656
- parameter recognizer: The recognizer that initially recognized the tap.
@@ -73,7 +73,7 @@ public protocol MapDoubleTapGestureDelegate : class {
7373
/// Long Press Gesture Delegate
7474
public protocol MapLongPressGestureDelegate : class {
7575
/**
76-
Asks the delegate if the map should recognize this long press gesture and perform default functionality.
76+
Asks the delegate if the map should recognize this long press gesture and perform default functionality (which is nothing, currently).
7777

7878
- parameter controller: The MapViewController that wants to recognize the press.
7979
- parameter recognizer: The recognizer that initially recognized the press.
@@ -187,7 +187,7 @@ public protocol MapTileLoadDelegate : class {
187187
/**
188188
MapViewController is the main class utilized for displaying Mapzen maps on iOS. It aims to provide the full set of features a developer would want for mapping-related tasks, such as displaying routes, results of a search, or the device's current location (and any combination therein.)
189189

190-
MapViewController wraps the underlying `TGMapViewController` from Tangram-es and handles adding it to the view hierarchy. It exposes this
190+
MapViewController wraps the underlying `TGMapViewController` from Tangram-es and handles adding it to the view hierarchy. It exposes this in the `tgViewController` property and allows for additional customization there using the Tangram-es iOS framework. Documentation on that is available [here](https://mapzen.com/documentation/tangram/iOS-API/).
191191
*/
192192
open class MapViewController: UIViewController, LocationManagerDelegate {
193193

@@ -206,7 +206,7 @@ open class MapViewController: UIViewController, LocationManagerDelegate {
206206
open var currentAnnotations: [PeliasMapkitAnnotation : TGMapMarkerId] = Dictionary()
207207
open var attributionBtn = UIButton()
208208

209-
/// The camera type we want to use. Defaults to standard top-down (flat) camera.
209+
/// The camera type we want to use. Defaults to whatever is set in the style sheet.
210210
open var cameraType: TGCameraType {
211211
set {
212212
tgViewController.cameraType = cameraType
@@ -216,7 +216,7 @@ open class MapViewController: UIViewController, LocationManagerDelegate {
216216
}
217217
}
218218

219-
/// The current position of the map in latitude / longitude.
219+
/// The current position of the map in longitude / latitude.
220220
open var position: TGGeoPoint {
221221
set {
222222
tgViewController.position = position
@@ -310,7 +310,7 @@ open class MapViewController: UIViewController, LocationManagerDelegate {
310310

311311
- returns: A fully formed MapViewController.
312312
*/
313-
init(){
313+
init() {
314314
application = UIApplication.shared
315315
super.init(nibName: nil, bundle: nil)
316316
}
@@ -613,7 +613,7 @@ open class MapViewController: UIViewController, LocationManagerDelegate {
613613
}
614614

615615
/**
616-
Convenience function that converts TGGeopPoints to UIKit screen coordinates.
616+
Convenience function that converts TGGeoPoints to UIKit screen coordinates.
617617

618618
- parameter lngLat: TGGeoPoint to convert
619619
- returns: The CGPoint in screen space.

0 commit comments

Comments
 (0)