tei/MapLibreParticleLab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[ios] Fix jazzy doc generation failure and document MGLGeoJSONSource

Browse Source 
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.
This commit is contained in:
Jason Wray
2016-09-02 20:59:43 -04:00
parent 52f23614b3
commit 51b2033fce
2 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
platform/darwin/src/MGLGeoJSONSource.h
View File

@@ -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;

3
platform/darwin/src/MGLVectorSource.h
View File

@@ -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