Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
[ios, macos] revised descriptions for abstract classes
Browse files Browse the repository at this point in the history
  • Loading branch information
jmkiley committed May 24, 2017
1 parent a57e9bc commit 48a3db5
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 31 deletions.
5 changes: 2 additions & 3 deletions platform/darwin/src/MGLForegroundStyleLayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ NS_ASSUME_NONNULL_BEGIN
`MGLForegroundStyleLayer` is an abstract superclass for style layers whose
content is defined by an `MGLSource` object.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, create instances of `MGLRasterStyleLayer`
and the concrete subclasses of `MGLVectorStyleLayer`.
Create instances of `MGLRasterStyleLayer` and the concrete subclasses of
`MGLVectorStyleLayer` in order to use `MGLForegroundStyleLayer`'s methods.
*/
MGL_EXPORT
@interface MGLForegroundStyleLayer : MGLStyleLayer
Expand Down
7 changes: 3 additions & 4 deletions platform/darwin/src/MGLMultiPoint.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ NS_ASSUME_NONNULL_BEGIN
The `MGLMultiPoint` class is an abstract superclass used to define shapes
composed of multiple vertices.
You do not create instances of this class directly. Instead, you create
instances of the `MGLPolyline` or `MGLPolygon` classes. However, you can use
the method and properties of this class to access information about the
vertices of the line or polygon.
Create instances of `MGLPolyline` or `MGLPolygon` in order to use
properties of `MGLMultiPoint`. You can use the method and properties of this
class to access information about the vertices of the line or polygon.
Do not confuse `MGLMultiPoint` with `MGLPointCollection`, which represents a
collection of related but disconnected points.
Expand Down
7 changes: 3 additions & 4 deletions platform/darwin/src/MGLShape.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ NS_ASSUME_NONNULL_BEGIN
constitute the content of a map – not only the overlays atop the map, but also
the content that forms the base map.
You do not create instances of this class directly or create subclasses of this
class. Instead, you create instances of `MGLPointAnnotation`,
`MGLPointCollection`, `MGLPolyline`, `MGLMultiPolyline`, `MGLPolygon`,
`MGLMultiPolygon`, or `MGLShapeCollection`. The shape classes correspond to the
Create instances of `MGLPointAnnotation`, `MGLPointCollection`, `MGLPolyline`,
`MGLMultiPolyline`, `MGLPolygon`, `MGLMultiPolygon`, or `MGLShapeCollection` in
order to use `MGLShape`'s methods. The shape classes correspond to the
<a href="https://tools.ietf.org/html/rfc7946#section-3.1">Geometry</a> object
types in the GeoJSON standard, but some have nonstandard names for backwards
compatibility.
Expand Down
6 changes: 3 additions & 3 deletions platform/darwin/src/MGLSource.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ NS_ASSUME_NONNULL_BEGIN
add and remove sources dynamically using methods such as
`-[MGLStyle addSource:]` and `-[MGLStyle sourceWithIdentifier:]`.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, create instances of `MGLShapeSource` and the
concrete subclasses of `MGLTileSource`, `MGLVectorSource` and `MGLRasterSource`.
Create instances of `MGLShapeSource` and the concrete subclasses of
`MGLTileSource`, `MGLVectorSource` and `MGLRasterSource` in order to use
`MGLMultiPoint`'s properties and methods.
*/
MGL_EXPORT
@interface MGLSource : NSObject
Expand Down
6 changes: 2 additions & 4 deletions platform/darwin/src/MGLStyleLayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ NS_ASSUME_NONNULL_BEGIN
`MGLStyleLayer` object, which you can use to refine the map’s appearance. You
can also add and remove style layers dynamically.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, create instances of
`MGLBackgroundStyleLayer` and the concrete subclasses of
`MGLForegroundStyleLayer`.
Create instances of `MGLBackgroundStyleLayer` and the concrete subclasses of
`MGLForegroundStyleLayer` in order to use `MGLStyleLayer`'s properties and methods.
Do not add `MGLStyleLayer` objects to the `style` property of a `MGLMapView` before
`-mapView:didFinishLoadingStyle:` is called.
Expand Down
7 changes: 2 additions & 5 deletions platform/darwin/src/MGLStyleValue.h
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,8 @@ MGL_EXPORT
defined by an `MGLCameraStyleFunction`, `MGLSourceStyleFunction`, or
`MGLCompositeStyleFunction` object.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, use one of the class factory methods in
`MGLStyleValue` to create instances of the following concrete subclasses:
`MGLCameraStyleFunction`, `MGLSourceStyleFunction`, and
`MGLCompositeStyleFunction`.
Create instances of `MGLCameraStyleFunction`, `MGLSourceStyleFunction`, and
`MGLCompositeStyleFunction` in order to use `MGLStyleFunction`'s methods.
The `MGLStyleFunction` class takes a generic parameter `T` that indicates the
Foundation class being wrapped by this class.
Expand Down
5 changes: 2 additions & 3 deletions platform/darwin/src/MGLTileSource.h
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,8 @@ typedef NS_ENUM(NSUInteger, MGLTileCoordinateSystem) {
Mapbox-hosted tile set, view it in
<a href="https://www.mapbox.com/studio/tilesets/">Mapbox Studio’s Tilesets editor</a>.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, create instances of `MGLRasterSource` and
`MGLVectorSource`.
Create instances of `MGLRasterSource` and `MGLVectorSource` in order to use
`MGLTileSource`'s properties and methods.
*/
MGL_EXPORT
@interface MGLTileSource : MGLSource
Expand Down
6 changes: 2 additions & 4 deletions platform/darwin/src/MGLVectorStyleLayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ NS_ASSUME_NONNULL_BEGIN
`MGLVectorStyleLayer` is an abstract superclass for style layers whose content
is defined by an `MGLShapeSource` or `MGLVectorSource` object.
Do not create instances of this class directly, and do not create your own
subclasses of this class. Instead, create instances of the following concrete
subclasses: `MGLCircleStyleLayer`, `MGLFillStyleLayer`, `MGLLineStyleLayer`,
and `MGLSymbolStyleLayer`.
Create instances of `MGLCircleStyleLayer`, `MGLFillStyleLayer`, `MGLLineStyleLayer`,
and `MGLSymbolStyleLayer` in order to use `MGLVectorStyleLayer`'s properties and methods.
*/
MGL_EXPORT
@interface MGLVectorStyleLayer : MGLForegroundStyleLayer
Expand Down
2 changes: 1 addition & 1 deletion platform/ios/src/MGLUserLocation.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
The MGLUserLocation class defines a specific type of annotation that identifies
the user’s current location. You do not create instances of this class
directly. Instead, you retrieve an existing MGLUserLocation object from the
directly. Instead, you retrieve an existing `MGLUserLocation` object from the
`userLocation` property of the map view displayed in your application.
*/
@interface MGLUserLocation : NSObject <MGLAnnotation, NSSecureCoding>
Expand Down

0 comments on commit 48a3db5

Please sign in to comment.