Skip to content

Commit 0684a07

Browse files
committed
Fix check warnings
1 parent b0ee173 commit 0684a07

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

api/src/Map.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,31 +61,31 @@ import Search from 'api/Search';
6161

6262
/**
6363
* @typedef {Object} MarkerOptions
64-
* @property {[number, number]} [position]
65-
* @property {string} [icon]
64+
* @property {[number, number]} [position] coordinates of the marker.
65+
* @property {string} [icon] image path for the marker.
6666
*/
6767

6868
/**
6969
* @typedef {Object} MapOptions
70-
* @property {string} div
71-
* @property {import('ol/coordinate').Coordinate} center
72-
* @property {number} [zoom=10]
73-
* @property {boolean} [showCoords=true]
74-
* @property {boolean} [addMiniMap=false]
75-
* @property {boolean} [miniMapExpanded=true]
76-
* @property {boolean} [addLayerSwitcher=false]
77-
* @property {boolean} [searchDiv]
78-
* @property {string[]} [layers]
79-
* @property {string[]} [backgroundLayers]
70+
* @property {string} div target to render the map into.
71+
* @property {import('ol/coordinate').Coordinate} center coordinater of the map's center.
72+
* @property {number} [zoom=10] initial zoom.
73+
* @property {boolean} [showCoords=true] show coordinates or not.
74+
* @property {boolean} [addMiniMap=false] with mini map or not.
75+
* @property {boolean} [miniMapExpanded=true] allow mini map expand or not.
76+
* @property {boolean} [addLayerSwitcher=false] with or without layer switcher.
77+
* @property {boolean} [searchDiv] div containing the search element.
78+
* @property {string[]} [layers] layers on the map.
79+
* @property {string[]} [backgroundLayers] backgrounds on the map.
8080
*/
8181

8282
/**
8383
* Attr is ['title', 'description'] by default
8484
*
8585
* @typedef {Object} CustomLayer
86-
* @property {string[]} [attr]
87-
* @property {function(): void} [success]
88-
* @property {function(): void} [error]
86+
* @property {string[]} [attr] attributes of the layer.
87+
* @property {function(): void} [success] success callback.
88+
* @property {function(): void} [error] error callback.
8989
*/
9090

9191
/**

0 commit comments

Comments
 (0)