Merge pull request #452 from fschmenger/enhance_js_doc

Enhance js doc

Author: fschmenger

src/components/measuretool/MeasureWin.vue

@@ -104,9 +104,8 @@ export default {
      * Called as callback of MeasureTypeChooser
      *
      * @param  {String} newMeasureType New measure type
-     * @param  {String} oldMeasureType Old measure type
      */
-    applyMeasureType (newMeasureType, oldMeasureType) {
+    applyMeasureType (newMeasureType) {
       this.measureType = newMeasureType;
     },
     /**

src/components/ol/HoverController.js

@@ -28,7 +28,7 @@ export default class HoverController {
    * 'hoverAttribute' if the layer is configured as 'hoverable'
    *
    * @param {ol.Map} map OpenLayers map.
-   * @param {object} hoverConf Global configuration options.
+   * @param {object} [hoverConf] Optional global configuration options.
    */
   constructor (map, hoverConf) {
     const me = this;
@@ -162,7 +162,7 @@ export default class HoverController {
    * @param {ol.Map} map OpenLayers map.
    * @param {ol.layer.Tile | ol.layer.Image} layer The layer to acquire the features for.
    * @param {ol.Coordinate} coordinate The coordinate in map projection.
-   * @param {AbortController} abortCtrl An optional abort controller to abort the request.
+   * @param {AbortController} [abortCtrl] An optional abort controller to abort the request.
    * @returns {Promise<Array<ol.Feature>>}
    */
   getWMSFeaturesAsync (map, layer, coordinate, abortCtrl) {

src/components/ol/Map.vue

@@ -375,7 +375,7 @@ export default {
      * property declared there will take precedence over the ones declared in the
      * language packs.
      *
-     * @param {ol.layer.Layer} OL layer instance
+     * @param {ol.layer.Layer} layer OL layer instance
      */
     updateLocalizedLayerProps (layer) {
       const langKey = layer.get('langKey') || layer.get('lid');

src/components/overviewmap/OverviewMapController.js

@@ -15,7 +15,7 @@ export default class OverviewMapController {
    * Construction
    * @param {ol.Map} map OpenLayers map.
    * @param {HTMLElement} target The target container to render the control.
-   * @param {Object} config The overview map configuration object.
+   * @param {Object} [config] Optional overview map configuration object.
    */
   constructor (map, target, config) {
     this.map = map;

src/components/progress/MapLoadingStatus.vue

@@ -44,8 +44,6 @@ export default {
 
     /**
      * Registers the needed events on the map.
-     *
-     * @param  {ol/layer/Base | ol/layer/Group} layer Layer or group to register
      */
     registerMapEvents () {
       this.map.on('loadstart', this.showLoader);

src/factory/Layer.js

@@ -57,7 +57,7 @@ export const LayerFactory = {
    * Returns an OpenLayers layer instance due to given config.
    *
    * @param  {Object} lConf  Layer config object
-   * @param  {ol/Map} olMap  Optional OL map we work on
+   * @param  {ol/Map} [olMap]  Optional OL map, required for WFS layer only.
    * @return {ol/layer/Base} OL layer instance
    */
   getInstance (lConf, olMap) {

src/util/ColorTheme.js

@@ -165,7 +165,7 @@ const ColorThemeUtil = {
 
   /**
    * Builds the theme object used by Vuetify
-   * @param {Object} inputConfig user configuration from app-config
+   * @param {Object} [inputConfig] optional user configuration from app-config
    * @returns {Object} theme object
    */
   buildTheme: function (inputConfig) {

src/util/Layer.js

@@ -44,7 +44,7 @@ const LayerUtil = {
    *
    * @param  {ol.layer.Base} vecLayer OL vector layer
    * @param  {ol.Map} olMap           The map to perform the zoom on
-   * @param {Object} options          Optional animation configuration
+   * @param {Object} [options]        Optional animation configuration
    */
   zoomToLayerExtent (vecLayer, olMap, options) {
     if (!vecLayer || !vecLayer.getSource().getExtent || !olMap) {

src/util/LayerLegend.js

@@ -10,7 +10,7 @@ class LayerLegend {
   /**
    * Instantiates a layer legend object with the legend options configured
    * in the application context.
-   * @param {Object} options  Application wide legend options.
+   * @param {Object} [options] Optional application wide legend options.
    */
   constructor (options) {
     this.options = options;
@@ -19,7 +19,7 @@ class LayerLegend {
   /**
    * Merges the given legend options with the legend options configured
    * in the application context. The provided options will take precedence.
-   * @param {Object} options Optional configuration params.
+   * @param {Object} [options] Optional configuration params.
    * @returns {Object} Merged configuration params.
    */
   getOptions (options) {
@@ -33,8 +33,8 @@ class LayerLegend {
    * Returns a URL to the layers legend image.
    * @param {ol.Layer} layer The layer to produce the legend for.
    * @param {Number} resolution Resolution of the legend image.
-   * @param {Object} options Optional configuration params.
-   * @param {String} formatUrl A custom format URL.
+   * @param {Object} [options] Optional configuration params.
+   * @param {String} [formatUrl] An optional custom format URL.
    * @returns {String} Legend URL or undefined if no legend can be produced.
    */
   getUrl (layer, resolution, options, formatUrl) {
@@ -69,7 +69,7 @@ const CustomLegend = {
    * This replaces the parameter placeholders in formatUrl.
    * @param {ol.Source} source The source to produce the legend for.
    * @param {Number} resolution Resolution of the legend image.
-   * @param {Object} options Optional configuration params.
+   * @param {Object} [options] Optional configuration params.
    * @param {String} formatUrl  A custom format URL.
    * @returns {String} The legend URL.
    */
@@ -99,7 +99,7 @@ const WMSSourceLegend = {
    * Returns a URL to the legend image.
    * @param {ol.Source} source The source to produce the legend for.
    * @param {Number} resolution Resolution of the legend image.
-   * @param {Object} options Optional configuration params.
+   * @param {Object} [options] Optional configuration params.
    * @returns {String} The legend URL.
    */
   getUrl (source, resolution, options) {

src/util/MapInteraction.js

@@ -9,8 +9,8 @@ const MapInteractionUtil = {
    * Create a selectInteraction for a layer
    *
    * @param {ol.layer.Layer} layer The layer to create the interaction for
-   * @param {Object} [selectStyleConf] The configuration for the selection style
-   * @param {Boolean} [doAppendSelectStyle] If the selection style should be appended to the original style.
+   * @param {Object} [selectStyleConf] Optional configuration for the selection style
+   * @param {Boolean} doAppendSelectStyle Whether the selection style should be appended to the original style.
    *
    * @returns {ol.interaction.Select} The select interaction
    */