Merge pull request #8099 from openlayers/jsdoc_module

More Jsdoc module fixes

src/ol/control/ZoomSlider.js

@@ -127,7 +127,7 @@ const ZoomSlider = function(opt_options) {
   containerElement.className = className + ' ' + CLASS_UNSELECTABLE + ' ' + CLASS_CONTROL;
   containerElement.appendChild(thumbElement);
   /**
-   * @type {ol.pointer.PointerEventHandler}
+   * @type {module:ol/pointer/PointerEventHandler~PointerEventHandler}
    * @private
    */
   this.dragger_ = new PointerEventHandler(containerElement);
@@ -249,7 +249,7 @@ ZoomSlider.prototype.handleContainerClick_ = function(event) {
 
 /**
  * Handle dragger start events.
- * @param {ol.pointer.PointerEvent} event The drag event.
+ * @param {module:ol/pointer/PointerEvent~PointerEvent} event The drag event.
  * @private
  */
 ZoomSlider.prototype.handleDraggerStart_ = function(event) {
@@ -265,7 +265,7 @@ ZoomSlider.prototype.handleDraggerStart_ = function(event) {
 /**
  * Handle dragger drag events.
  *
- * @param {ol.pointer.PointerEvent|Event} event The drag event.
+ * @param {module:ol/pointer/PointerEvent~PointerEvent|Event} event The drag event.
  * @private
  */
 ZoomSlider.prototype.handleDraggerDrag_ = function(event) {
@@ -285,7 +285,7 @@ ZoomSlider.prototype.handleDraggerDrag_ = function(event) {
 
 /**
  * Handle dragger end events.
- * @param {ol.pointer.PointerEvent|Event} event The drag event.
+ * @param {module:ol/pointer/PointerEvent~PointerEvent|Event} event The drag event.
  * @private
  */
 ZoomSlider.prototype.handleDraggerEnd_ = function(event) {

src/ol/layer/Vector.js

@@ -40,7 +40,7 @@ import {createDefaultStyle, toFunction as toStyleFunction} from '../style/Style.
  * @property {boolean} [declutter=false] Declutter images and text. Decluttering is applied to all
  * image and text styles, and the priority is defined by the z-index of the style. Lower z-index
  * means higher priority.
- * @property {module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|ol.StyleFunction} [style] Layer style. See
+ * @property {module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|module:ol/style~StyleFunction} [style] Layer style. See
  * {@link ol.style} for default style which will be used if this is not defined.
  * @property {number} [maxTilesLoading=16] Maximum number tiles to load simultaneously.
  * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be

src/ol/layer/VectorTile.js

@@ -49,7 +49,7 @@ import {assign} from '../obj.js';
  * image and text styles, and the priority is defined by the z-index of the style. Lower z-index
  * means higher priority. When set to `true`, a `renderMode` of `'image'` will be overridden with
  * `'hybrid'`.
- * @property {module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|ol.StyleFunction} [style] Layer style. See
+ * @property {module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|module:ol/style~StyleFunction} [style] Layer style. See
  * {@link ol.style} for default style which will be used if this is not defined.
  * @property {number} [maxTilesLoading=16] Maximum number tiles to load simultaneously.
  * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be
@@ -62,7 +62,7 @@ import {assign} from '../obj.js';
  * means no preloading.
  * @property {ol.RenderOrderFunction} [renderOrder] Render order. Function to be used when sorting
  * features before rendering. By default features are drawn in the order that they are created.
- * @property {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|ol.StyleFunction)} [style] Layer style. See
+ * @property {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|module:ol/style~StyleFunction)} [style] Layer style. See
  * {@link ol.style} for default style which will be used if this is not defined.
  * @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
  */

src/ol/pointer/EventSource.js

@@ -2,14 +2,13 @@
  * @module ol/pointer/EventSource
  */
 /**
- * @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher Event handler.
- * @param {!Object.<string, function(Event)>} mapping Event
+ * @param {!Object.<string, function(Event)>} mapping Event mapping.
- *     mapping.
  * @constructor
  */
 const EventSource = function(dispatcher, mapping) {
   /**
-   * @type {ol.pointer.PointerEventHandler}
+   * @type {module:ol/pointer/PointerEventHandler~PointerEventHandler}
    */
   this.dispatcher = dispatcher;
 

src/ol/pointer/MouseSource.js

@@ -35,9 +35,9 @@ import {inherits} from '../index.js';
 import EventSource from '../pointer/EventSource.js';
 
 /**
- * @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher Event handler.
  * @constructor
- * @extends {ol.pointer.EventSource}
+ * @extends {module:ol/pointer/EventSource~EventSource}
  */
 const MouseSource = function(dispatcher) {
   const mapping = {
@@ -131,7 +131,7 @@ MouseSource.prototype.isEventSimulatedFromTouch_ = function(inEvent) {
  * for the fake pointer event.
  *
  * @param {Event} inEvent The in event.
- * @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher Event handler.
  * @return {Object} The copied event.
  */
 function prepareEvent(inEvent, dispatcher) {

src/ol/pointer/MsSource.js

@@ -35,9 +35,9 @@ import {inherits} from '../index.js';
 import EventSource from '../pointer/EventSource.js';
 
 /**
- * @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher Event handler.
  * @constructor
- * @extends {ol.pointer.EventSource}
+ * @extends {module:ol/pointer/EventSource~EventSource}
  */
 const MsSource = function(dispatcher) {
   const mapping = {

src/ol/pointer/NativeSource.js

@@ -35,9 +35,9 @@ import {inherits} from '../index.js';
 import EventSource from '../pointer/EventSource.js';
 
 /**
- * @param {ol.pointer.PointerEventHandler} dispatcher Event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher Event handler.
  * @constructor
- * @extends {ol.pointer.EventSource}
+ * @extends {module:ol/pointer/EventSource~EventSource}
  */
 const NativeSource = function(dispatcher) {
   const mapping = {

src/ol/pointer/PointerEventHandler.js

@@ -70,7 +70,7 @@ const PointerEventHandler = function(element) {
   this.eventMap_ = {};
 
   /**
-   * @type {Array.<ol.pointer.EventSource>}
+   * @type {Array.<module:ol/pointer/EventSource~EventSource>}
    * @private
    */
   this.eventSourceList_ = [];
@@ -147,7 +147,7 @@ PointerEventHandler.prototype.registerSources = function() {
  * Add a new event source that will generate pointer events.
  *
  * @param {string} name A name for the event source
- * @param {ol.pointer.EventSource} source The source event.
+ * @param {module:ol/pointer/EventSource~EventSource} source The source event.
  */
 PointerEventHandler.prototype.registerSource = function(name, source) {
   const s = source;
@@ -388,7 +388,7 @@ PointerEventHandler.prototype.contains_ = function(container, contained) {
  * @param {string} inType A string representing the type of event to create.
  * @param {Object} data Pointer event data.
  * @param {Event} event The event.
- * @return {ol.pointer.PointerEvent} A PointerEvent of type `inType`.
+ * @return {module:ol/pointer/PointerEvent~PointerEvent} A PointerEvent of type `inType`.
  */
 PointerEventHandler.prototype.makeEvent = function(inType, data, event) {
   return new PointerEvent(inType, event, data);
@@ -423,7 +423,7 @@ PointerEventHandler.prototype.fireNativeEvent = function(event) {
  * This proxy method is required for the legacy IE support.
  * @param {string} eventType The pointer event type.
  * @param {Event} event The event.
- * @return {ol.pointer.PointerEvent} The wrapped event.
+ * @return {module:ol/pointer/PointerEvent~PointerEvent} The wrapped event.
  */
 PointerEventHandler.prototype.wrapMouseEvent = function(eventType, event) {
   const pointerEvent = this.makeEvent(

src/ol/pointer/TouchSource.js

@@ -39,9 +39,9 @@ import {POINTER_ID} from '../pointer/MouseSource.js';
 
 /**
  * @constructor
- * @param {ol.pointer.PointerEventHandler} dispatcher The event handler.
+ * @param {module:ol/pointer/PointerEventHandler~PointerEventHandler} dispatcher The event handler.
- * @param {ol.pointer.MouseSource} mouseSource Mouse source.
+ * @param {module:ol/pointer/MouseSource~MouseSource} mouseSource Mouse source.
- * @extends {ol.pointer.EventSource}
+ * @extends {module:ol/pointer/EventSource~EventSource}
  */
 const TouchSource = function(dispatcher, mouseSource) {
   const mapping = {
@@ -60,7 +60,7 @@ const TouchSource = function(dispatcher, mouseSource) {
 
   /**
    * @const
-   * @type {ol.pointer.MouseSource}
+   * @type {module:ol/pointer/MouseSource~MouseSource}
    */
   this.mouseSource = mouseSource;