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

Commit 51b2033

Browse files
committed
[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.
1 parent 52f2361 commit 51b2033

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

platform/darwin/src/MGLGeoJSONSource.h

+17-4
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ extern NSString * const MGLGeoJSONBufferOption;
5050
*/
5151
extern NSString * const MGLGeoJSONToleranceOption;
5252

53+
54+
/**
55+
A GeoJSON source.
56+
57+
@see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">The
58+
style specification.</a>
59+
*/
5360
@interface MGLGeoJSONSource : MGLSource
5461

5562
/**
@@ -91,11 +98,14 @@ extern NSString * const MGLGeoJSONToleranceOption;
9198
- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier geoJSONData:(NSData *)data NS_DESIGNATED_INITIALIZER;
9299

93100
/**
94-
Initializes a source with the given identifier, GeoJSON data, and a dictionary of options for the source.
101+
Initializes a source with the given identifier, GeoJSON data, and a dictionary
102+
of options for the source as specified by the
103+
<a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the
104+
style specification</a>.
95105
96106
@param sourceIdentifier A string that uniquely identifies the source.
97107
@param geoJSONData An NSData object representing GeoJSON source code.
98-
@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>.
108+
@param options An NSDictionary of attributes for this source.
99109
*/
100110
- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier geoJSONData:(NSData *)data options:(NS_DICTIONARY_OF(NSString *, id) *)options NS_DESIGNATED_INITIALIZER;
101111

@@ -109,12 +119,15 @@ extern NSString * const MGLGeoJSONToleranceOption;
109119
- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier URL:(NSURL *)url NS_DESIGNATED_INITIALIZER;
110120

111121
/**
112-
Initializes a source with the given identifier, a URL, and a dictionary of options for the source.
122+
Initializes a source with the given identifier, a URL, and a dictionary of
123+
options for the source as specified by the
124+
<a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">the
125+
style specification</a>.
113126
114127
@param sourceIdentifier A string that uniquely identifies the source.
115128
@param URL An HTTP(S) URL, absolute file URL, or local file URL relative to the
116129
current application’s resource bundle.
117-
@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>.
130+
@param options An NSDictionary of attributes for this source.
118131
*/
119132
- (instancetype)initWithSourceIdentifier:(NSString *)sourceIdentifier URL:(NSURL *)url options:(NS_DICTIONARY_OF(NSString *, id) *)options NS_DESIGNATED_INITIALIZER;
120133

platform/darwin/src/MGLVectorSource.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
/**
44
A vector tile source. Tiles must be in Mapbox Vector Tile format.
55
6-
@see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-vector">the style specification</a>
6+
@see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-vector">The
7+
style specification.</a>
78
*/
89
@interface MGLVectorSource : MGLSource
910

0 commit comments

Comments
 (0)