diff options
author | Justin R. Miller <incanus@users.noreply.github.com> | 2016-09-27 13:53:32 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-09-27 13:53:32 -0700 |
commit | a6aa786f35824922aee0d2baad94e4ce9f71e79c (patch) | |
tree | 4ca6fed37ec4d713b82c9f06da5f3d326e92bb0d /platform/darwin/src/MGLSource.h | |
parent | 44c7e9d05edbe6fee9e8f98b91380b6c07e57ac7 (diff) | |
download | qtlocation-mapboxgl-a6aa786f35824922aee0d2baad94e4ce9f71e79c.tar.gz |
[ios, macos] flesh out iOS runtime styling docs (#6466)
- fixes #5959: MGLBaseStyleLayer docs
- fixes #5960: MGLSource & subclasses docs
- fixes #6467: concrete layer subclass docs
- move Core Graphics include
- slight code & template cleanups
- add ./documentation to git ignores
Diffstat (limited to 'platform/darwin/src/MGLSource.h')
-rw-r--r-- | platform/darwin/src/MGLSource.h | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/platform/darwin/src/MGLSource.h b/platform/darwin/src/MGLSource.h index 4d0fd49ea2..bb8f990828 100644 --- a/platform/darwin/src/MGLSource.h +++ b/platform/darwin/src/MGLSource.h @@ -1,10 +1,25 @@ #import <Foundation/Foundation.h> -#import <CoreGraphics/CoreGraphics.h> +/** + A source supplies data to be shown on the map. Sources don't contain styling + details like color or width. Use subclasses of `MGLBaseStyleLayer` to give + visual representation to sources. + + You should use the concrete subclasses of `MGLSource` to create vector, + raster, GeoJSON, and other source types. + */ @interface MGLSource : NSObject +/** + A string that uniquely identifies the source. + */ @property (nonatomic, copy) NSString *sourceIdentifier; +/** + Initializes a source with the given identifier. + + @param sourceIdentifier A string that uniquely identifies the source. + */ - (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier; @end |