Replace @see with See.

This commit is contained in:
Tim Schaub
2018-07-19 08:37:32 -06:00
parent d46471d763
commit e1e34e5636
12 changed files with 15 additions and 15 deletions

View File

@@ -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 {

View File

@@ -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).

View File

@@ -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
*/

View File

@@ -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

View File

@@ -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:
*

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -4,7 +4,7 @@
// FIXME check order of async callbacks
/**
* @see http://mapbox.com/developers/api/
* See http://mapbox.com/developers/api/.
*/

View File

@@ -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
*/

View File

@@ -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 {