@@ -61,31 +61,31 @@ import Search from 'api/Search';
61
61
62
62
/**
63
63
* @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.
66
66
*/
67
67
68
68
/**
69
69
* @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.
80
80
*/
81
81
82
82
/**
83
83
* Attr is ['title', 'description'] by default
84
84
*
85
85
* @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.
89
89
*/
90
90
91
91
/**
0 commit comments