summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLSource.h
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-12-08 03:40:59 -0800
committerMinh Nguyễn <mxn@1ec5.org>2016-12-10 14:58:01 -0800
commit3fed3c10edb2cd015bd733a22c56ace7af900ef8 (patch)
tree94705abe7ece234a4c123204cfdc5416a5f120d1 /platform/darwin/src/MGLSource.h
parent7f75eb5d6ae014391f3baf066a9873c5fb1c1ded (diff)
downloadqtlocation-mapboxgl-3fed3c10edb2cd015bd733a22c56ace7af900ef8.tar.gz
[ios, macos] Expanded source documentation
Also fixed a few stray references to GeoJSON sources.
Diffstat (limited to 'platform/darwin/src/MGLSource.h')
-rw-r--r--platform/darwin/src/MGLSource.h18
1 files changed, 13 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLSource.h b/platform/darwin/src/MGLSource.h
index ec3733bf08..f0a8aacecb 100644
--- a/platform/darwin/src/MGLSource.h
+++ b/platform/darwin/src/MGLSource.h
@@ -1,12 +1,20 @@
#import <Foundation/Foundation.h>
/**
- A source supplies data to be shown on the map. Sources don't contain styling
- details like color or width. Use subclasses of `MGLStyleLayer` to give visual
- representation to sources.
+ `MGLSource` is an abstract base class for map content sources. A map content
+ source supplies content to be shown on the map. A source is added to an
+ `MGLStyle` object along with an `MGLForegroundStyleLayer` object. The
+ foreground style layer defines the appearance of any content supplied by the
+ source.
- You should use the concrete subclasses of `MGLSource` to create vector,
- raster, GeoJSON, and other source types.
+ Each source defined by the style JSON file is represented at runtime by an
+ `MGLSource` object that you can use to refine the map’s content. You can also
+ 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 `MGLRasterSource`,
+ `MGLShapeSource`, and `MGLVectorSource`.
*/
@interface MGLSource : NSObject