From e1e34e5636747a13cc9aacd5aa83994d5316f81f Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 19 Jul 2018 08:37:32 -0600 Subject: [PATCH] Replace @see with See. --- src/ol/AssertionError.js | 2 +- src/ol/Geolocation.js | 4 ++-- src/ol/MapBrowserEvent.js | 4 ++-- src/ol/events/Event.js | 2 +- src/ol/events/EventTarget.js | 2 +- src/ol/events/condition.js | 2 +- src/ol/geom/Geometry.js | 2 +- src/ol/obj.js | 2 +- src/ol/render/webgl/PolygonReplay.js | 2 +- src/ol/source/TileJSON.js | 2 +- src/ol/structs/PriorityQueue.js | 4 ++-- src/ol/structs/RBush.js | 2 +- 12 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/ol/AssertionError.js b/src/ol/AssertionError.js index 1e0d299bfd..f6df8887ea 100644 --- a/src/ol/AssertionError.js +++ b/src/ol/AssertionError.js @@ -6,7 +6,7 @@ import {VERSION} from './util.js'; /** * Error object thrown when an assertion failed. This is an ECMA-262 Error, * extended with a `code` property. - * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error. */ class AssertionError extends Error { diff --git a/src/ol/Geolocation.js b/src/ol/Geolocation.js index 1bbbc5be57..84115dffca 100644 --- a/src/ol/Geolocation.js +++ b/src/ol/Geolocation.js @@ -285,7 +285,7 @@ class Geolocation extends BaseObject { /** * Get the tracking options. - * @see http://www.w3.org/TR/geolocation-API/#position-options + * See http://www.w3.org/TR/geolocation-API/#position-options. * @return {PositionOptions|undefined} PositionOptions as defined by * the [HTML5 Geolocation spec * ](http://www.w3.org/TR/geolocation-API/#position_options_interface). @@ -319,7 +319,7 @@ class Geolocation extends BaseObject { /** * Set the tracking options. - * @see http://www.w3.org/TR/geolocation-API/#position-options + * See http://www.w3.org/TR/geolocation-API/#position-options. * @param {PositionOptions} options PositionOptions as defined by the * [HTML5 Geolocation spec * ](http://www.w3.org/TR/geolocation-API/#position_options_interface). diff --git a/src/ol/MapBrowserEvent.js b/src/ol/MapBrowserEvent.js index a807f7c4c7..dc680a6c1e 100644 --- a/src/ol/MapBrowserEvent.js +++ b/src/ol/MapBrowserEvent.js @@ -56,7 +56,7 @@ class MapBrowserEvent extends MapEvent { /** * Prevents the default browser action. - * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault + * See https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault. * @override * @api */ @@ -67,7 +67,7 @@ class MapBrowserEvent extends MapEvent { /** * Prevents further propagation of the current event. - * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation + * See https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation. * @override * @api */ diff --git a/src/ol/events/Event.js b/src/ol/events/Event.js index c0633f72a9..1e5a1af1b2 100644 --- a/src/ol/events/Event.js +++ b/src/ol/events/Event.js @@ -5,7 +5,7 @@ /** * @classdesc * Stripped down implementation of the W3C DOM Level 2 Event interface. - * @see https://www.w3.org/TR/DOM-Level-2-Events/events.html#Events-interface + * See https://www.w3.org/TR/DOM-Level-2-Events/events.html#Events-interface. * * This implementation only provides `type` and `target` properties, and * `stopPropagation` and `preventDefault` methods. It is meant as base class diff --git a/src/ol/events/EventTarget.js b/src/ol/events/EventTarget.js index 00343e08da..c23ce69680 100644 --- a/src/ol/events/EventTarget.js +++ b/src/ol/events/EventTarget.js @@ -15,7 +15,7 @@ import Event from '../events/Event.js'; /** * @classdesc * A simplified implementation of the W3C DOM Level 2 EventTarget interface. - * @see https://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-EventTarget + * See https://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-EventTarget. * * There are two important simplifications compared to the specification: * diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js index c8a1d1c66d..a2cf454768 100644 --- a/src/ol/events/condition.js +++ b/src/ol/events/condition.js @@ -237,7 +237,7 @@ export const mouseOnly = function(mapBrowserEvent) { /** * Return `true` if the event originates from a primary pointer in * contact with the surface or if the left mouse button is pressed. - * @see http://www.w3.org/TR/pointerevents/#button-states + * See http://www.w3.org/TR/pointerevents/#button-states. * * @param {module:ol/MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event originates from a primary pointer. diff --git a/src/ol/geom/Geometry.js b/src/ol/geom/Geometry.js index 80fbc90641..df3256f655 100644 --- a/src/ol/geom/Geometry.js +++ b/src/ol/geom/Geometry.js @@ -171,7 +171,7 @@ class Geometry extends BaseObject { /** * Create a simplified version of this geometry using the Douglas Peucker * algorithm. - * @see https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm + * See https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm. * @abstract * @param {number} squaredTolerance Squared tolerance. * @return {module:ol/geom/Geometry} Simplified geometry. diff --git a/src/ol/obj.js b/src/ol/obj.js index ef6ecf3fcf..63be5f721c 100644 --- a/src/ol/obj.js +++ b/src/ol/obj.js @@ -6,8 +6,8 @@ /** * Polyfill for Object.assign(). Assigns enumerable and own properties from * one or more source objects to a target object. + * See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign. * - * @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign * @param {!Object} target The target object. * @param {...Object} var_sources The source object(s). * @return {!Object} The modified target object. diff --git a/src/ol/render/webgl/PolygonReplay.js b/src/ol/render/webgl/PolygonReplay.js index 0b69e32a8e..84edb993d8 100644 --- a/src/ol/render/webgl/PolygonReplay.js +++ b/src/ol/render/webgl/PolygonReplay.js @@ -690,7 +690,7 @@ class WebGLPolygonReplay extends WebGLReplay { /** * Line intersection algorithm by Paul Bourke. - * @see http://paulbourke.net/geometry/pointlineplane/ + * See http://paulbourke.net/geometry/pointlineplane/. * * @private * @param {module:ol/render/webgl/PolygonReplay~PolygonVertex} p0 First point. diff --git a/src/ol/source/TileJSON.js b/src/ol/source/TileJSON.js index 0b5f24e2cf..dcbd8805c8 100644 --- a/src/ol/source/TileJSON.js +++ b/src/ol/source/TileJSON.js @@ -4,7 +4,7 @@ // FIXME check order of async callbacks /** - * @see http://mapbox.com/developers/api/ + * See http://mapbox.com/developers/api/. */ diff --git a/src/ol/structs/PriorityQueue.js b/src/ol/structs/PriorityQueue.js index c82eb12a77..a5858490d0 100644 --- a/src/ol/structs/PriorityQueue.js +++ b/src/ol/structs/PriorityQueue.js @@ -17,8 +17,8 @@ export const DROP = Infinity; * The implementation is inspired from the Closure Library's Heap class and * Python's heapq module. * - * @see http://closure-library.googlecode.com/svn/docs/closure_goog_structs_heap.js.source.html - * @see http://hg.python.org/cpython/file/2.7/Lib/heapq.py + * See http://closure-library.googlecode.com/svn/docs/closure_goog_structs_heap.js.source.html + * and http://hg.python.org/cpython/file/2.7/Lib/heapq.py. * * @template T */ diff --git a/src/ol/structs/RBush.js b/src/ol/structs/RBush.js index 3221b85086..a2c9ef318a 100644 --- a/src/ol/structs/RBush.js +++ b/src/ol/structs/RBush.js @@ -17,8 +17,8 @@ import {isEmpty} from '../obj.js'; /** * Wrapper around the RBush by Vladimir Agafonkin. + * See https://github.com/mourner/rbush. * - * @see https://github.com/mourner/rbush * @template T */ class RBush {