summaryrefslogtreecommitdiff
path: root/platform/darwin/src
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-05-09 16:05:14 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-05-10 09:59:04 -0700
commit1634058b51da4885224ba7f63aab14c7d794652f (patch)
tree810318a22f6d165466eace6804c247626b7fe891 /platform/darwin/src
parenta025d8327afeea74a9a1a8c9a9a237e21af917bb (diff)
downloadqtlocation-mapboxgl-1634058b51da4885224ba7f63aab14c7d794652f.tar.gz
[ios, osx] Reformatted documentation comments
Reformatted documentation comments in public headers in the OS X SDK and public headers shared between the iOS and OS X SDKs to wrap at column 80 and avoid excessive indentation that causes SourceKitten to detect code blocks.
Diffstat (limited to 'platform/darwin/src')
-rw-r--r--platform/darwin/src/MGLAnnotation.h21
-rw-r--r--platform/darwin/src/MGLGeometry.h28
-rw-r--r--platform/darwin/src/MGLMapCamera.h38
-rw-r--r--platform/darwin/src/MGLMultiPoint.h19
-rw-r--r--platform/darwin/src/MGLOverlay.h37
-rw-r--r--platform/darwin/src/MGLPointAnnotation.h11
-rw-r--r--platform/darwin/src/MGLPolygon.h13
-rw-r--r--platform/darwin/src/MGLPolyline.h13
-rw-r--r--platform/darwin/src/MGLShape.h22
-rw-r--r--platform/darwin/src/MGLStyle.h96
10 files changed, 227 insertions, 71 deletions
diff --git a/platform/darwin/src/MGLAnnotation.h b/platform/darwin/src/MGLAnnotation.h
index e4726f9503..7293aeec4f 100644
--- a/platform/darwin/src/MGLAnnotation.h
+++ b/platform/darwin/src/MGLAnnotation.h
@@ -7,15 +7,26 @@
NS_ASSUME_NONNULL_BEGIN
/**
- The `MGLAnnotation` protocol is used to provide annotation-related information to a map view. To use this protocol, you adopt it in any custom objects that store or represent annotation data. Each object then serves as the source of information about a single map annotation and provides critical information, such as the annotation’s location on the map. Annotation objects do not provide the visual representation of the annotation but typically coordinate (in conjunction with the map view’s delegate) the creation of an appropriate objects to handle the display.
+ The `MGLAnnotation` protocol is used to provide annotation-related information
+ to a map view. To use this protocol, you adopt it in any custom objects that
+ store or represent annotation data. Each object then serves as the source of
+ information about a single map annotation and provides critical information,
+ such as the annotation’s location on the map. Annotation objects do not provide
+ the visual representation of the annotation but typically coordinate (in
+ conjunction with the map view’s delegate) the creation of an appropriate
+ objects to handle the display.
- An object that adopts this protocol must implement the `coordinate` property. The other methods of this protocol are optional.
+ An object that adopts this protocol must implement the `coordinate` property.
+ The other methods of this protocol are optional.
*/
@protocol MGLAnnotation <NSObject>
#pragma mark Position Attributes
-/** The center point (specified as a map coordinate) of the annotation. (required) (read-only) */
+/**
+ The center point (specified as a map coordinate) of the annotation. (required)
+ (read-only)
+ */
@property (nonatomic, readonly) CLLocationCoordinate2D coordinate;
@optional
@@ -25,7 +36,9 @@ NS_ASSUME_NONNULL_BEGIN
/**
The string containing the annotation’s title.
- Although this property is optional, if you support the selection of annotations in your map view, you are expected to provide this property. This string is displayed in the callout for the associated annotation.
+ Although this property is optional, if you support the selection of annotations
+ in your map view, you are expected to provide this property. This string is
+ displayed in the callout for the associated annotation.
*/
@property (nonatomic, readonly, copy, nullable) NSString *title;
diff --git a/platform/darwin/src/MGLGeometry.h b/platform/darwin/src/MGLGeometry.h
index 7ad5140400..af54d7b391 100644
--- a/platform/darwin/src/MGLGeometry.h
+++ b/platform/darwin/src/MGLGeometry.h
@@ -14,7 +14,10 @@ typedef struct MGLCoordinateSpan {
CLLocationDegrees longitudeDelta;
} MGLCoordinateSpan;
-/** Creates a new `MGLCoordinateSpan` from the given latitudinal and longitudinal deltas. */
+/**
+ Creates a new `MGLCoordinateSpan` from the given latitudinal and longitudinal
+ deltas.
+ */
NS_INLINE MGLCoordinateSpan MGLCoordinateSpanMake(CLLocationDegrees latitudeDelta, CLLocationDegrees longitudeDelta) {
MGLCoordinateSpan span;
span.latitudeDelta = latitudeDelta;
@@ -22,7 +25,10 @@ NS_INLINE MGLCoordinateSpan MGLCoordinateSpanMake(CLLocationDegrees latitudeDelt
return span;
}
-/** Returns `YES` if the two coordinate spans represent the same latitudinal change and the same longitudinal change. */
+/**
+ Returns `YES` if the two coordinate spans represent the same latitudinal change
+ and the same longitudinal change.
+ */
NS_INLINE BOOL MGLCoordinateSpanEqualToCoordinateSpan(MGLCoordinateSpan span1, MGLCoordinateSpan span2) {
return (span1.latitudeDelta == span2.latitudeDelta &&
span1.longitudeDelta == span2.longitudeDelta);
@@ -39,7 +45,10 @@ typedef struct MGLCoordinateBounds {
CLLocationCoordinate2D ne;
} MGLCoordinateBounds;
-/** Creates a new `MGLCoordinateBounds` structure from the given southwest and northeast coordinates. */
+/**
+ Creates a new `MGLCoordinateBounds` structure from the given southwest and
+ northeast coordinates.
+ */
NS_INLINE MGLCoordinateBounds MGLCoordinateBoundsMake(CLLocationCoordinate2D sw, CLLocationCoordinate2D ne) {
MGLCoordinateBounds bounds;
bounds.sw = sw;
@@ -61,7 +70,10 @@ NS_INLINE MGLCoordinateSpan MGLCoordinateBoundsGetCoordinateSpan(MGLCoordinateBo
bounds.ne.longitude - bounds.sw.longitude);
}
-/** Returns a coordinate bounds with southwest and northeast coordinates that are offset from those of the source bounds. */
+/**
+ Returns a coordinate bounds with southwest and northeast coordinates that are
+ offset from those of the source bounds.
+ */
NS_INLINE MGLCoordinateBounds MGLCoordinateBoundsOffset(MGLCoordinateBounds bounds, MGLCoordinateSpan offset) {
MGLCoordinateBounds offsetBounds = bounds;
offsetBounds.sw.latitude += offset.latitudeDelta;
@@ -71,8 +83,12 @@ NS_INLINE MGLCoordinateBounds MGLCoordinateBoundsOffset(MGLCoordinateBounds boun
return offsetBounds;
}
-/** Returns `YES` if the coordinate bounds covers no area.
- Note that a bounds may be empty but have a non-zero coordinate span (e.g., when its northeast point lies due north of its southwest point). */
+/**
+ Returns `YES` if the coordinate bounds covers no area.
+
+ @note A bounds may be empty but have a non-zero coordinate span (e.g., when its
+ northeast point lies due north of its southwest point).
+ */
NS_INLINE BOOL MGLCoordinateBoundsIsEmpty(MGLCoordinateBounds bounds) {
MGLCoordinateSpan span = MGLCoordinateBoundsGetCoordinateSpan(bounds);
return span.latitudeDelta == 0 || span.longitudeDelta == 0;
diff --git a/platform/darwin/src/MGLMapCamera.h b/platform/darwin/src/MGLMapCamera.h
index 3cb902ba52..4b50c32b2f 100644
--- a/platform/darwin/src/MGLMapCamera.h
+++ b/platform/darwin/src/MGLMapCamera.h
@@ -6,7 +6,10 @@
NS_ASSUME_NONNULL_BEGIN
-/** An `MGLMapCamera` object represents a viewpoint from which the user observes some point on an `MGLMapView`. */
+/**
+ An `MGLMapCamera` object represents a viewpoint from which the user observes
+ some point on an `MGLMapView`.
+ */
@interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>
/** Coordinate at the center of the map view. */
@@ -15,7 +18,10 @@ NS_ASSUME_NONNULL_BEGIN
/** Heading measured in degrees clockwise from true north. */
@property (nonatomic) CLLocationDirection heading;
-/** Pitch toward the horizon measured in degrees, with 0 degrees resulting in a two-dimensional map. */
+/**
+ Pitch toward the horizon measured in degrees, with 0 degrees resulting in a
+ two-dimensional map.
+ */
@property (nonatomic) CGFloat pitch;
/** Meters above ground level. */
@@ -25,11 +31,16 @@ NS_ASSUME_NONNULL_BEGIN
+ (instancetype)camera;
/**
- Returns a new camera using based on information about the camera’s viewpoint and focus point.
+ Returns a new camera using based on information about the camera’s viewpoint
+ and focus point.
- @param centerCoordinate The geographic coordinate on which the map should be centered.
- @param eyeCoordinate The geometric coordinate at which the camera should be situated.
- @param eyeAltitude The altitude (measured in meters) above the map at which the camera should be situated. The altitude may be less than the distance from the camera’s viewpoint to the camera’s focus point.
+ @param centerCoordinate The geographic coordinate on which the map should be
+ centered.
+ @param eyeCoordinate The geometric coordinate at which the camera should be
+ situated.
+ @param eyeAltitude The altitude (measured in meters) above the map at which the
+ camera should be situated. The altitude may be less than the distance from
+ the camera’s viewpoint to the camera’s focus point.
*/
+ (instancetype)cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
fromEyeCoordinate:(CLLocationCoordinate2D)eyeCoordinate
@@ -38,10 +49,17 @@ NS_ASSUME_NONNULL_BEGIN
/**
Returns a new camera with the given distance, pitch, and heading.
- @param centerCoordinate The geographic coordinate on which the map should be centered.
- @param distance The straight-line distance from the viewpoint to the `centerCoordinate`.
- @param pitch The viewing angle of the camera, measured in degrees. A value of `0` results in a camera pointed straight down at the map. Angles greater than `0` result in a camera angled toward the horizon.
- @param heading The camera’s heading, measured in degrees clockwise from true north. A value of `0` means that the top edge of the map view corresponds to true north. The value `90` means the top of the map is pointing due east. The value `180` means the top of the map points due south, and so on.
+ @param centerCoordinate The geographic coordinate on which the map should be
+ centered.
+ @param distance The straight-line distance from the viewpoint to the
+ `centerCoordinate`.
+ @param pitch The viewing angle of the camera, measured in degrees. A value of
+ `0` results in a camera pointed straight down at the map. Angles greater
+ than `0` result in a camera angled toward the horizon.
+ @param heading The camera’s heading, measured in degrees clockwise from true
+ north. A value of `0` means that the top edge of the map view corresponds to
+ true north. The value `90` means the top of the map is pointing due east.
+ The value `180` means the top of the map points due south, and so on.
*/
+ (instancetype)cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
fromDistance:(CLLocationDistance)distance
diff --git a/platform/darwin/src/MGLMultiPoint.h b/platform/darwin/src/MGLMultiPoint.h
index ad9db1e681..041c52e8f2 100644
--- a/platform/darwin/src/MGLMultiPoint.h
+++ b/platform/darwin/src/MGLMultiPoint.h
@@ -7,7 +7,14 @@
NS_ASSUME_NONNULL_BEGIN
-/** The `MGLMultiPoint` class is an abstract superclass used to define shapes composed of multiple points. You should not create instances of this class directly. Instead, you should create instances of the `MGLPolyline` or `MGLPolygon` classes. However, you can use the method and properties of this class to access information about the specific points associated with the line or polygon. */
+/**
+ The `MGLMultiPoint` class is an abstract superclass used to define shapes
+ composed of multiple points. You should not create instances of this class
+ directly. Instead, you should create instances of the `MGLPolyline` or
+ `MGLPolygon` classes. However, you can use the method and properties of this
+ class to access information about the specific points associated with the line
+ or polygon.
+ */
@interface MGLMultiPoint : MGLShape
/** The number of points associated with the shape. (read-only) */
@@ -16,8 +23,14 @@ NS_ASSUME_NONNULL_BEGIN
/**
Retrieves one or more coordinates associated with the shape.
- @param coords On input, you must provide a C array of structures large enough to hold the desired number of coordinates. On output, this structure contains the requested coordinate data.
- @param range The range of points you want. The `location` field indicates the first point you are requesting, with `0` being the first point, `1` being the second point, and so on. The `length` field indicates the number of points you want. The array in _`coords`_ must be large enough to accommodate the number of requested coordinates.
+ @param coords On input, you must provide a C array of structures large enough
+ to hold the desired number of coordinates. On output, this structure
+ contains the requested coordinate data.
+ @param range The range of points you want. The `location` field indicates the
+ first point you are requesting, with `0` being the first point, `1` being
+ the second point, and so on. The `length` field indicates the number of
+ points you want. The array in _`coords`_ must be large enough to accommodate
+ the number of requested coordinates.
*/
- (void)getCoordinates:(CLLocationCoordinate2D *)coords range:(NSRange)range;
diff --git a/platform/darwin/src/MGLOverlay.h b/platform/darwin/src/MGLOverlay.h
index aa80fe3900..ba03b19737 100644
--- a/platform/darwin/src/MGLOverlay.h
+++ b/platform/darwin/src/MGLOverlay.h
@@ -9,35 +9,56 @@
NS_ASSUME_NONNULL_BEGIN
/**
- The `MGLOverlay` protocol defines a specific type of annotation that represents both a point and an area on a map. Overlay objects are essentially data objects that contain the geographic data needed to represent the map area. For example, overlays can take the form of common shapes such as rectangles and circles. They can also describe polygons and other complex shapes.
+ The `MGLOverlay` protocol defines a specific type of annotation that represents
+ both a point and an area on a map. Overlay objects are essentially data objects
+ that contain the geographic data needed to represent the map area. For example,
+ overlays can take the form of common shapes such as rectangles and circles.
+ They can also describe polygons and other complex shapes.
- You use overlays to layer more sophisticated content on top of a map view. For example, you could use an overlay to show the boundaries of a national park or trace a bus route along city streets. The Mapbox iOS SDK defines several concrete classes that conform to this protocol and define standard shapes.
+ You use overlays to layer more sophisticated content on top of a map view. For
+ example, you could use an overlay to show the boundaries of a national park or
+ trace a bus route along city streets. This SDK defines several concrete classes
+ that conform to this protocol and define standard shapes.
- Because overlays are also annotations, they have similar usage pattern to annotations. When added to a map view using the `-addOverlay:` method, that view detects whenever the overlay’s defined region intersects the visible portion of the map. At that point, the map view asks its delegate to provide a special overlay view to draw the visual representation of the overlay. If you add an overlay to a map view as an annotation instead, it is treated as an annotation with a single point.
+ Because overlays are also annotations, they have similar usage pattern to
+ annotations. When added to a map view using the `-addOverlay:` method, that
+ view detects whenever the overlay’s defined region intersects the visible
+ portion of the map. At that point, the map view asks its delegate to provide a
+ special overlay view to draw the visual representation of the overlay. If you
+ add an overlay to a map view as an annotation instead, it is treated as an
+ annotation with a single point.
*/
@protocol MGLOverlay <MGLAnnotation>
/**
The approximate center point of the overlay area. (required) (read-only)
- This point is typically set to the center point of the map’s bounding rectangle. It is used as the anchor point for any callouts displayed for the annotation.
+ This point is typically set to the center point of the map’s bounding
+ rectangle. It is used as the anchor point for any callouts displayed for the
+ annotation.
*/
@property (nonatomic, readonly) CLLocationCoordinate2D coordinate;
/**
The cooordinate rectangle that encompasses the overlay. (required) (read-only)
- This property contains the smallest rectangle that completely encompasses the overlay. Implementers of this protocol must set this area when implementing their overlay class, and after setting it, you must not change it.
+ This property contains the smallest rectangle that completely encompasses the
+ overlay. Implementers of this protocol must set this area when implementing
+ their overlay class, and after setting it, you must not change it.
*/
@property (nonatomic, readonly) MGLCoordinateBounds overlayBounds;
/**
- Returns a Boolean indicating whether the specified rectangle intersects the receiver’s shape.
+ Returns a Boolean indicating whether the specified rectangle intersects the
+ receiver’s shape.
- You can implement this method to provide more specific bounds checking for an overlay. If you do not implement it, the bounding rectangle is used to detect intersections.
+ You can implement this method to provide more specific bounds checking for an
+ overlay. If you do not implement it, the bounding rectangle is used to detect
+ intersections.
@param overlayBounds The rectangle to intersect with the receiver’s area.
- @return `YES` if any part of the map rectangle intersects the receiver’s shape or `NO` if it does not.
+ @return `YES` if any part of the map rectangle intersects the receiver’s shape
+ or `NO` if it does not.
*/
- (BOOL)intersectsOverlayBounds:(MGLCoordinateBounds)overlayBounds;
diff --git a/platform/darwin/src/MGLPointAnnotation.h b/platform/darwin/src/MGLPointAnnotation.h
index d186cbff18..13afcab717 100644
--- a/platform/darwin/src/MGLPointAnnotation.h
+++ b/platform/darwin/src/MGLPointAnnotation.h
@@ -7,10 +7,17 @@
NS_ASSUME_NONNULL_BEGIN
-/** The `MGLPointAnnotation` class defines a concrete annotation object located at a specified point. You can use this class, rather than define your own, in situations where all you want to do is associate a point on the map with a title. */
+/**
+ The `MGLPointAnnotation` class defines a concrete annotation object located at
+ a specified point. You can use this class, rather than define your own, in
+ situations where all you want to do is associate a point on the map with a
+ title.
+ */
@interface MGLPointAnnotation : MGLShape
-/** The coordinate point of the annotation, specified as a latitude and longitude. */
+/**
+ The coordinate point of the annotation, specified as a latitude and longitude.
+ */
@property (nonatomic, assign) CLLocationCoordinate2D coordinate;
@end
diff --git a/platform/darwin/src/MGLPolygon.h b/platform/darwin/src/MGLPolygon.h
index c5480264fb..1a158874bb 100644
--- a/platform/darwin/src/MGLPolygon.h
+++ b/platform/darwin/src/MGLPolygon.h
@@ -8,13 +8,20 @@
NS_ASSUME_NONNULL_BEGIN
-/** The `MGLPolygon` class represents a shape consisting of one or more points that define a closed polygon. The points are connected end-to-end in the order they are provided. The first and last points are connected to each other to create the closed shape. */
+/**
+ The `MGLPolygon` class represents a shape consisting of one or more points that
+ define a closed polygon. The points are connected end-to-end in the order they
+ are provided. The first and last points are connected to each other to create
+ the closed shape.
+ */
@interface MGLPolygon : MGLMultiPoint <MGLOverlay>
/**
- Creates and returns an `MGLPolygon` object from the specified set of coordinates.
+ Creates and returns an `MGLPolygon` object from the specified set of
+ coordinates.
- @param coords The array of coordinates defining the shape. The data in this array is copied to the new object.
+ @param coords The array of coordinates defining the shape. The data in this
+ array is copied to the new object.
@param count The number of items in the `coords` array.
@return A new polygon object.
*/
diff --git a/platform/darwin/src/MGLPolyline.h b/platform/darwin/src/MGLPolyline.h
index c28299c7e0..5e45513735 100644
--- a/platform/darwin/src/MGLPolyline.h
+++ b/platform/darwin/src/MGLPolyline.h
@@ -8,13 +8,20 @@
NS_ASSUME_NONNULL_BEGIN
-/** The `MGLPolyline` class represents a shape consisting of one or more points that define connecting line segments. The points are connected end-to-end in the order they are provided. The first and last points are not connected to each other. */
+/**
+ The `MGLPolyline` class represents a shape consisting of one or more points
+ that define connecting line segments. The points are connected end-to-end in
+ the order they are provided. The first and last points are not connected to
+ each other.
+ */
@interface MGLPolyline : MGLMultiPoint <MGLOverlay>
/**
- Creates and returns an `MGLPolyline` object from the specified set of coordinates.
+ Creates and returns an `MGLPolyline` object from the specified set of
+ coordinates.
- @param coords The array of coordinates defining the shape. The data in this array is copied to the new object.
+ @param coords The array of coordinates defining the shape. The data in this
+ array is copied to the new object.
@param count The number of items in the `coords` array.
@return A new polyline object.
*/
diff --git a/platform/darwin/src/MGLShape.h b/platform/darwin/src/MGLShape.h
index c1b84816f2..40c92fc32d 100644
--- a/platform/darwin/src/MGLShape.h
+++ b/platform/darwin/src/MGLShape.h
@@ -6,18 +6,32 @@
NS_ASSUME_NONNULL_BEGIN
-/** The `MGLShape` class is an abstract class that defines the basic properties for all shape-based annotation objects. This class must be subclassed and cannot be used as is. Subclasses are responsible for defining the geometry of the shape and providing an appropriate value for the coordinate property inherited from the `MGLAnnotation` protocol. */
+/**
+ The `MGLShape` class is an abstract class that defines the basic properties for
+ all shape-based annotation objects. This class must be subclassed and cannot be
+ used as is. Subclasses are responsible for defining the geometry of the shape
+ and providing an appropriate value for the coordinate property inherited from
+ the `MGLAnnotation` protocol.
+ */
@interface MGLShape : NSObject <MGLAnnotation>
-/** The title of the shape annotation. The default value of this property is `nil`. */
+/**
+ The title of the shape annotation. The default value of this property is `nil`.
+ */
@property (nonatomic, copy, nullable) NSString *title;
-/** The subtitle of the shape annotation. The default value of this property is `nil`. */
+/**
+ The subtitle of the shape annotation. The default value of this property is
+ `nil`.
+ */
@property (nonatomic, copy, nullable) NSString *subtitle;
#if !TARGET_OS_IPHONE
-/** The tooltip of the shape annotation. The default value of this property is `nil`. */
+/**
+ The tooltip of the shape annotation. The default value of this property is
+ `nil`.
+ */
@property (nonatomic, copy, nullable) NSString *toolTip;
#endif
diff --git a/platform/darwin/src/MGLStyle.h b/platform/darwin/src/MGLStyle.h
index 65d45dc98e..8577522b96 100644
--- a/platform/darwin/src/MGLStyle.h
+++ b/platform/darwin/src/MGLStyle.h
@@ -5,116 +5,156 @@
NS_ASSUME_NONNULL_BEGIN
/**
- A version number identifying the default version of the suite of default styles provided by Mapbox. This version number may be passed into one of the “StyleURLWithVersion” class methods of MGLStyle.
-
- The value of this constant generally corresponds to the latest released version as of the date on which this SDK was published. You can use this constant to ascertain the style used by `MGLMapView` and `MGLTilePyramidOfflineRegion` when no style URL is specified. Consult the <a href="https://www.mapbox.com/api-documentation/#styles">Mapbox Styles API documentation</a> for the most up-to-date style versioning information.
-
- @warning The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific aspect of a default style – for instance, the minimum zoom level that includes roads – you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such details may change significantly from version to version.
+ A version number identifying the default version of the suite of default styles
+ provided by Mapbox. This version number may be passed into one of the
+ “StyleURLWithVersion” class methods of MGLStyle.
+
+ The value of this constant generally corresponds to the latest released version
+ as of the date on which this SDK was published. You can use this constant to
+ ascertain the style used by `MGLMapView` and `MGLTilePyramidOfflineRegion` when
+ no style URL is specified. Consult the
+ <a href="https://www.mapbox.com/api-documentation/#styles">Mapbox Styles API documentation</a>
+ for the most up-to-date style versioning information.
+
+ @warning The value of this constant may change in a future release of the SDK.
+ If you use any feature that depends on a specific aspect of a default style
+ – for instance, the minimum zoom level that includes roads – you may use the
+ current value of this constant or the underlying style URL, but do not use
+ the constant itself. Such details may change significantly from version to
+ version.
*/
static const NSInteger MGLStyleDefaultVersion = 9;
/**
- A collection of convenience methods for creating style URLs of default styles provided by Mapbox. <a href="https://www.mapbox.com/maps/">Learn more about Mapbox default styles</a>.
+ A collection of convenience methods for creating style URLs of default styles
+ provided by Mapbox.
+ <a href="https://www.mapbox.com/maps/">Learn more about Mapbox default styles</a>.
*/
@interface MGLStyle : NSObject
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
Streets is a general-purpose style with detailed road and transit networks.
- `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style is specified explicitly.
+ `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style
+ is specified explicitly.
*/
+ (NSURL *)streetsStyleURL __attribute__((deprecated("Use -streetsStyleURLWithVersion:.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
Streets is a general-purpose style with detailed road and transit networks.
- `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style is specified explicitly.
+ `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style
+ is specified explicitly.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)streetsStyleURLWithVersion:(NSInteger)version;
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/blog/emerald-gl/">Mapbox Emerald</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/blog/emerald-gl/">Mapbox Emerald</a> style.
Emerald is a tactile style with subtle textures and dramatic hillshading.
*/
+ (NSURL *)emeraldStyleURL __attribute__((deprecated("Create an NSURL object with the string “mapbox://styles/mapbox/emerald-v8”.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/outdoors/">Mapbox Outdoors</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/outdoors/">Mapbox Outdoors</a> style.
Outdoors is a general-purpose style tailored to outdoor activities.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version;
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
Light is a subtle, light-colored backdrop for data visualizations.
*/
+ (NSURL *)lightStyleURL __attribute__((deprecated("Use -lightStyleURLWithVersion:.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
Light is a subtle, light-colored backdrop for data visualizations.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)lightStyleURLWithVersion:(NSInteger)version;
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
Dark is a subtle, dark-colored backdrop for data visualizations.
*/
+ (NSURL *)darkStyleURL __attribute__((deprecated("Use -darkStyleURLWithVersion:.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
Dark is a subtle, dark-colored backdrop for data visualizations.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)darkStyleURLWithVersion:(NSInteger)version;
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
Satellite is high-resolution satellite and aerial imagery.
*/
+ (NSURL *)satelliteStyleURL __attribute__((deprecated("Use -satelliteStyleURLWithVersion:.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
Satellite is high-resolution satellite and aerial imagery.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)satelliteStyleURLWithVersion:(NSInteger)version;
/**
- Returns the URL to version 8 of the <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a> style.
+ Returns the URL to version 8 of the
+ <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a>
+ style.
- Satellite Streets combines the high-resolution satellite and aerial imagery of Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox Streets.
+ Satellite Streets combines the high-resolution satellite and aerial imagery of
+ Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox
+ Streets.
*/
+ (NSURL *)hybridStyleURL __attribute__((deprecated("Use -satelliteStreetsStyleURLWithVersion:.")));
/**
- Returns the URL to the given version of the <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a> style.
+ Returns the URL to the given version of the
+ <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a>
+ style.
- Satellite Streets combines the high-resolution satellite and aerial imagery of Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox Streets.
+ Satellite Streets combines the high-resolution satellite and aerial imagery of
+ Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox
+ Streets.
- @param version The style’s latest released version. As of publication, the current version is `9`.
+ @param version The style’s latest released version. As of publication, the
+ current version is `9`.
*/
+ (NSURL *)satelliteStreetsStyleURLWithVersion:(NSInteger)version;