Skip to content

Commit b0ee29b

Browse files
committed
docs: refine comments for docs
- Refine comments for the API document.
1 parent 51a5f76 commit b0ee29b

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

src/index.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
/**
2-
* Utility for
2+
* Collision box utility for
33
* {@link https://docs.mapbox.com/mapbox-gl-js/guides/|Mapbox GL JS}.
44
*
5+
* @packageDocumentation
6+
*
57
* @beta
68
*/
79

@@ -30,12 +32,17 @@ const PLACEMENT_TIMEOUT_IN_MS = 5000;
3032
*
3133
* @param map -
3234
*
33-
* Mapbox map instance.
35+
* {@link https://docs.mapbox.com/mapbox-gl-js/api/map/|Mapbox map} instance.
3436
*
3537
* @param layerId -
3638
*
3739
* ID of the layer where collision boxes are to be collected.
3840
*
41+
* @returns
42+
*
43+
* Collision boxes and features on the layer associated with `layerId` on
44+
* `map`.
45+
*
3946
* @throws RangeError
4047
*
4148
* If there is no layer associated with `layerId`, or if the layer associated

src/types.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,14 @@ export interface Box {
2424
export interface FeatureBox {
2525
/** Box of the feature. */
2626
box: Box;
27-
/** Feature. */
27+
/**
28+
* Feature.
29+
*
30+
* @remarks
31+
*
32+
* Contains similar information you can get with
33+
* {@link https://docs.mapbox.com/mapbox-gl-js/api/map/#map#queryrenderedfeatures|Map#queryRenderedFeatures}.
34+
*/
2835
feature: QueryFeature;
2936
}
3037

@@ -33,7 +40,8 @@ export interface FeatureBox {
3340
*
3441
* @remarks
3542
*
36-
* `QueryFeature` is defined in https://github.com/mapbox/mapbox-gl-js/blob/e29e113ff5e1f4c073f84b8cbe546006d2fb604f/src/util/vectortile_to_geojson.js#L6-L9
43+
* `QueryFeature` is defined in
44+
* {@link https://github.com/mapbox/mapbox-gl-js/blob/e29e113ff5e1f4c073f84b8cbe546006d2fb604f/src/util/vectortile_to_geojson.js#L6-L9}
3745
*
3846
* `QueryFeature` is exported as `MapboxGeoJSONFeature` from `@types/mapbox-gl`.
3947
*

0 commit comments

Comments
 (0)