diff options
author | Jason Wray <jason@mapbox.com> | 2016-09-02 20:59:43 -0400 |
---|---|---|
committer | Jason Wray <jason@mapbox.com> | 2016-09-02 21:14:56 -0400 |
commit | 51b2033fce5ca4d016b67b94abc50c1822c139fe (patch) | |
tree | 0ec233470eca1f6b7e14f691ac50a703193eb682 | |
parent | 52f23614b34728ffea2dc7c2920a2bf6375c9458 (diff) | |
download | qtlocation-mapboxgl-51b2033fce5ca4d016b67b94abc50c1822c139fe.tar.gz |
[ios] Fix jazzy doc generation failure and document MGLGeoJSONSource
Clang/Sourcekitten do not appear to like HTML tags in `@param` definitions.
Also:
- Wraps lines at 80 chars.
- Adds minimal docs for MGLGeoJSONSource so it will be seen by jazzy.
-rw-r--r-- | platform/darwin/src/MGLGeoJSONSource.h | 21 | ||||
-rw-r--r-- | platform/darwin/src/MGLVectorSource.h | 3 |
2 files changed, 19 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLGeoJSONSource.h b/platform/darwin/src/MGLGeoJSONSource.h index 50cab015b0..7f02185db9 100644 --- a/platform/darwin/src/MGLGeoJSONSource.h +++ b/platform/darwin/src/MGLGeoJSONSource.h @@ -50,6 +50,13 @@ extern NSString * const MGLGeoJSONBufferOption; */ extern NSString * const MGLGeoJSONToleranceOption; + +/** + A GeoJSON source. + + @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">The + style specification.</a> + */ @interface MGLGeoJSONSource : MGLSource /** @@ -91,11 +98,14 @@ extern NSString * const MGLGeoJSONToleranceOption; - (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier geoJSONData:(NSData *)data NS_DESIGNATED_INITIALIZER; /** - Initializes a source with the given identifier, GeoJSON data, and a dictionary of options for the source. + Initializes a source with the given identifier, GeoJSON data, and a dictionary + of options for the source as specified by the + <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the + style specification</a>. @param sourceIdentifier A string that uniquely identifies the source. @param geoJSONData An NSData object representing GeoJSON source code. - @param options An NSDictionary of attributes for this source specified by the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the style specification</a>. + @param options An NSDictionary of attributes for this source. */ - (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier geoJSONData:(NSData *)data options:(NS_DICTIONARY_OF(NSString *, id) *)options NS_DESIGNATED_INITIALIZER; @@ -109,12 +119,15 @@ extern NSString * const MGLGeoJSONToleranceOption; - (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier URL:(NSURL *)url NS_DESIGNATED_INITIALIZER; /** - Initializes a source with the given identifier, a URL, and a dictionary of options for the source. + Initializes a source with the given identifier, a URL, and a dictionary of + options for the source as specified by the + <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the + style specification</a>. @param sourceIdentifier A string that uniquely identifies the source. @param URL An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle. - @param options An NSDictionary of attributes for this source specified by the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the style specification</a>. + @param options An NSDictionary of attributes for this source. */ - (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier URL:(NSURL *)url options:(NS_DICTIONARY_OF(NSString *, id) *)options NS_DESIGNATED_INITIALIZER; diff --git a/platform/darwin/src/MGLVectorSource.h b/platform/darwin/src/MGLVectorSource.h index 416ed1da9a..05e041511e 100644 --- a/platform/darwin/src/MGLVectorSource.h +++ b/platform/darwin/src/MGLVectorSource.h @@ -3,7 +3,8 @@ /** A vector tile source. Tiles must be in Mapbox Vector Tile format. - @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-vector">the style specification</a> + @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-vector">The + style specification.</a> */ @interface MGLVectorSource : MGLSource |