Merge pull request #74 from IGNF/feature-serviceOptions

docs(2D:Controls): met à jour la documentation du searchControl
IGNF · Feb 10, 2021 · acb5e13 · acb5e13
2 parents 96489e6 + 9751b7e
commit acb5e13
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/Map.js b/src/Map.js
@@ -821,8 +821,10 @@ var layerOptions = {
  * | resources.autocomplete | Array(String) | resources autocompletion, by default : ["PositionOfInterest", "StreetAddress"] |
  * | displayAdvancedSearch | Boolean | True to display advanced search tools. Default is false (not displayed) |
  * | advancedSearch | Object | advanced search options for geocoding (filters). Properties can be found among geocode options.filterOptions (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode) |
- * | geocodeOptions | Object | options of geocode service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode) |
- * | autocompleteOptions | Object | options of autocomplete service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete) |
+ * | geocodeOptions | Object | geocoding options of the control (see [SearchEngine doc](http://ignf.github.io/geoportal-extensions/openlayers-latest/jsdoc/ol.control.SearchEngine.html)) |
+ * | geocodeOptions.serviceOptions | Object | options of the geocode service (see [Gp.Services.geocode](https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode)) |
+ * | autocompleteOptions | Object | geocoding options of the control (see [SearchEngine doc](http://ignf.github.io/geoportal-extensions/openlayers-latest/jsdoc/ol.control.SearchEngine.html)) |
+ * | autocompleteOptions.serviceOptions | Object | options of the autocomplete service (see see [Gp.Services.autocomplete](https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete)) |
  *
  * <a id="reversesearch"></a>
  *

diff --git a/src/OpenLayers/OlMapControls.js b/src/OpenLayers/OlMapControls.js
@@ -982,8 +982,10 @@ OlMap.prototype.addElevationPathControl = function (controlOpts) {
  * @param {Array.<String>} controlOpts.resources.autocomplete - resources autocompletion, by default : ["PositionOfInterest", "StreetAddress"]
  * @param {Boolean} [controlOpts.displayAdvancedSearch = false] - True to display advanced search tools. Default is false (not displayed)
  * @param {Object} controlOpts.advancedSearch - advanced search options for geocoding (filters). Properties can be found among geocode options.filterOptions (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode)
- * @param {Object} [controlOpts.geocodeOptions = {}] - options of geocode service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode)
- * @param {Object} [controlOpts.autocompleteOptions = {}] - options of autocomplete service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete)
+ * @param {Object} [controlOpts.geocodeOptions = {}] - geocoding options of the control (see http://ignf.github.io/geoportal-extensions/openlayers-latest/jsdoc/ol.control.SearchEngine.html)
+ * @param {Object} [controlOpts.geocodeOptions.serviceOptions = {}] - options of the geocode service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~geocode)
+ * @param {Object} [controlOpts.autocompleteOptions = {}] - geocoding options of the control (see http://ignf.github.io/geoportal-extensions/openlayers-latest/jsdoc/ol.control.SearchEngine.html)
+ * @param {Object} [controlOpts.autocompleteOptions.serviceOptions = {}] - options of the autocomplete service (see https://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~autoComplete)
  *
  * @return {Ol.control.SearchEngine} control
  */