From 2e4b2e10ab0d8d20b2b28c539e55a76d78a523db Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Mon, 10 May 2021 17:30:55 -0600 Subject: [PATCH] Fix additional doc links --- src/ol/format/MVT.js | 2 +- src/ol/layer/BaseImage.js | 2 +- src/ol/layer/BaseTile.js | 2 +- src/ol/layer/BaseVector.js | 2 +- src/ol/layer/Layer.js | 10 +++++----- src/ol/layer/MapboxVector.js | 2 +- src/ol/layer/VectorImage.js | 5 +++-- src/ol/layer/VectorTile.js | 9 +++++---- src/ol/proj/Projection.js | 6 +++--- src/ol/render/canvas.js | 2 +- src/ol/render/canvas/Immediate.js | 8 ++++---- src/ol/source/Vector.js | 2 +- src/ol/source/VectorEventType.js | 2 +- 13 files changed, 28 insertions(+), 26 deletions(-) diff --git a/src/ol/format/MVT.js b/src/ol/format/MVT.js index 759e907f4f..456f652608 100644 --- a/src/ol/format/MVT.js +++ b/src/ol/format/MVT.js @@ -24,7 +24,7 @@ import {linearRingIsClockwise} from '../geom/flat/orient.js'; /** * @typedef {Object} Options * @property {import("../Feature.js").FeatureClass} [featureClass] Class for features returned by - * {@link module:ol/format/MVT#readFeatures}. Set to {@link module:ol/Feature~Feature} to get full editing and geometry + * {@link module:ol/format/MVT~MVT#readFeatures}. Set to {@link module:ol/Feature~Feature} to get full editing and geometry * support at the cost of decreased rendering performance. The default is * {@link module:ol/render/Feature~RenderFeature}, which is optimized for rendering and hit detection. * @property {string} [geometryName='geometry'] Geometry name to use when creating features. diff --git a/src/ol/layer/BaseImage.js b/src/ol/layer/BaseImage.js index 8c7e38c376..984103b87a 100644 --- a/src/ol/layer/BaseImage.js +++ b/src/ol/layer/BaseImage.js @@ -26,7 +26,7 @@ import Layer from './Layer.js'; * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {ImageSourceType} [source] Source for this layer. * @property {Object} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. */ diff --git a/src/ol/layer/BaseTile.js b/src/ol/layer/BaseTile.js index 4207a737df..947da058d3 100644 --- a/src/ol/layer/BaseTile.js +++ b/src/ol/layer/BaseTile.js @@ -31,7 +31,7 @@ import {assign} from '../obj.js'; * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error. * @property {Object} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. */ diff --git a/src/ol/layer/BaseVector.js b/src/ol/layer/BaseVector.js index 8c8ad65f16..008e8c5112 100644 --- a/src/ol/layer/BaseVector.js +++ b/src/ol/layer/BaseVector.js @@ -39,7 +39,7 @@ import { * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {boolean} [declutter=false] Declutter images and text. Decluttering is applied to all * image and text styles of all Vector and VectorTile layers that have set this to `true`. The priority * is defined by the z-index of the layer, the `zIndex` of the style and the render order of features. diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index 1dc67905d2..f6b96b7add 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -36,7 +36,7 @@ import {listen, unlistenByKey} from '../events.js'; * @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will * be visible. * @property {SourceType} [source] Source for this layer. If not provided to the constructor, - * the source can be set by calling {@link module:ol/layer/Layer#setSource layer.setSource(source)} after + * the source can be set by calling {@link module:ol/layer/Layer~Layer#setSource layer.setSource(source)} after * construction. * @property {import("../PluggableMap.js").default} [map] Map. * @property {RenderFunction} [render] Render function. Takes the frame state as input and is expected to return an @@ -69,7 +69,7 @@ import {listen, unlistenByKey} from '../events.js'; * Layers group together those properties that pertain to how the data is to be * displayed, irrespective of the source of that data. * - * Layers are usually added to a map with {@link module:ol/Map#addLayer}. Components + * Layers are usually added to a map with {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. Components * like {@link module:ol/interaction/Select~Select} use unmanaged layers * internally. These unmanaged layers are associated with the map using * {@link module:ol/layer/Layer~Layer#setMap} instead. @@ -77,7 +77,7 @@ import {listen, unlistenByKey} from '../events.js'; * A generic `change` event is fired when the state of the source changes. * * Please note that for performance reasons several layers might get rendered to - * the same HTML element, which will cause {@link module:ol/Map~Map#forEachLayerAtPixel} to + * the same HTML element, which will cause {@link import("../PluggableMap.js").default#forEachLayerAtPixel map.forEachLayerAtPixel()} to * give false positives. To avoid this, apply different `className` properties to the * layers at creation time. * @@ -237,12 +237,12 @@ class Layer extends BaseLayer { /** * Sets the layer to be rendered on top of other layers on a map. The map will * not manage this layer in its layers collection, and the callback in - * {@link module:ol/Map#forEachLayerAtPixel} will receive `null` as layer. This + * {@link module:ol/Map~Map#forEachLayerAtPixel} will receive `null` as layer. This * is useful for temporary layers. To remove an unmanaged layer from the map, * use `#setMap(null)`. * * To add the layer to a map and have it managed by the map, use - * {@link module:ol/Map#addLayer} instead. + * {@link module:ol/Map~Map#addLayer} instead. * @param {import("../PluggableMap.js").default} map Map. * @api */ diff --git a/src/ol/layer/MapboxVector.js b/src/ol/layer/MapboxVector.js index 3494fd740d..0b459fc4d2 100644 --- a/src/ol/layer/MapboxVector.js +++ b/src/ol/layer/MapboxVector.js @@ -202,7 +202,7 @@ const SourceType = { * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be * recreated during animations. This means that no vectors will be shown clipped, but the setting * will have a performance impact for large amounts of vector data. When set to `false`, batches diff --git a/src/ol/layer/VectorImage.js b/src/ol/layer/VectorImage.js index 9c01895cd7..b6c9b3d57b 100644 --- a/src/ol/layer/VectorImage.js +++ b/src/ol/layer/VectorImage.js @@ -35,12 +35,13 @@ import {assign} from '../obj.js'; * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {boolean} [declutter=false] Declutter images and text on this layer. The priority is defined * by the `zIndex` of the style and the render order of features. Higher z-index means higher priority. * Within the same z-index, a feature rendered before another has higher priority. * @property {import("../style/Style.js").StyleLike} [style] Layer style. See - * {@link module:ol/style} for default style which will be used if this is not defined. + * {@link import("../style/Style.js").default the style docs} for the default style that will be used if + * this is not defined. * @property {number} [imageRatio=1] Ratio by which the rendered extent should be larger than the * viewport extent. A larger ratio avoids cut images during panning, but will cause a decrease in performance. * @property {Object} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. diff --git a/src/ol/layer/VectorTile.js b/src/ol/layer/VectorTile.js index ca11b7f2d6..846add81d7 100644 --- a/src/ol/layer/VectorTile.js +++ b/src/ol/layer/VectorTile.js @@ -46,14 +46,15 @@ import {assign} from '../obj.js'; * @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage * this layer in its layers collection, and the layer will be rendered on top. This is useful for * temporary layers. The standard way to add a layer to a map and have it managed by the map is to - * use {@link module:ol/Map#addLayer}. + * use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}. * @property {boolean} [declutter=false] Declutter images and text. Decluttering is applied to all * image and text styles of all Vector and VectorTile layers that have set this to `true`. The priority * is defined by the z-index of the layer, the `zIndex` of the style and the render order of features. * Higher z-index means higher priority. Within the same z-index, a feature rendered before another has * higher priority. * @property {import("../style/Style.js").StyleLike} [style] Layer style. See - * {@link module:ol/style} for default style which will be used if this is not defined. + * {@link import("../style/Style.js").default the style docs} for the default style that will be used if + * this is not defined. * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be * recreated during animations. This means that no vectors will be shown clipped, but the setting * will have a performance impact for large amounts of vector data. When set to `false`, batches @@ -69,7 +70,7 @@ import {assign} from '../obj.js'; /** * @classdesc * Layer for vector tile data that is rendered client-side. - * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject} + * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject BaseObject} * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * @@ -134,7 +135,7 @@ class VectorTileLayer extends BaseVectorLayer { * when a hit was detected, or it will be empty. * * The hit detection algorithm used for this method is optimized for performance, but is less - * accurate than the one used in {@link import("../PluggableMap.js").default#getFeaturesAtPixel}: Text + * accurate than the one used in {@link import("../PluggableMap.js").default#getFeaturesAtPixel map.getFeaturesAtPixel()}: Text * is not considered, and icons are only represented by their bounding box instead of the exact * image. * diff --git a/src/ol/proj/Projection.js b/src/ol/proj/Projection.js index e426298eb3..1724e2535b 100644 --- a/src/ol/proj/Projection.js +++ b/src/ol/proj/Projection.js @@ -17,9 +17,9 @@ import {METERS_PER_UNIT} from './Units.js'; * @property {import("../extent.js").Extent} [worldExtent] The world extent for the SRS. * @property {function(number, import("../coordinate.js").Coordinate):number} [getPointResolution] * Function to determine resolution at a point. The function is called with a - * `{number}` view resolution and an `{import("../coordinate.js").Coordinate}` as arguments, and returns - * the `{number}` resolution in projection units at the passed coordinate. If this is `undefined`, - * the default {@link module:ol/proj#getPointResolution} function will be used. + * `number` view resolution and a {@link module:ol/coordinate~Coordinate Coordinate} as arguments, and returns + * the `number` resolution in projection units at the passed coordinate. If this is `undefined`, + * the default {@link module:ol/proj.getPointResolution getPointResolution()} function will be used. */ /** diff --git a/src/ol/render/canvas.js b/src/ol/render/canvas.js index 906928423d..fd3d531944 100644 --- a/src/ol/render/canvas.js +++ b/src/ol/render/canvas.js @@ -159,7 +159,7 @@ export const checkedFonts = new BaseObject(); /** * The label cache for text rendering. To change the default cache size of 2048 - * entries, use {@link module:ol/structs/LRUCache#setSize}. + * entries, use {@link module:ol/structs/LRUCache~LRUCache#setSize cache.setSize()}. * Deprecated - there is no label cache any more. * @type {?} * @api diff --git a/src/ol/render/canvas/Immediate.js b/src/ol/render/canvas/Immediate.js index 101d9fe22b..5074628e58 100644 --- a/src/ol/render/canvas/Immediate.js +++ b/src/ol/render/canvas/Immediate.js @@ -32,11 +32,11 @@ import {transformGeom2D} from '../../geom/SimpleGeometry.js'; /** * @classdesc - * A concrete subclass of {@link module:ol/render/VectorContext} that implements + * A concrete subclass of {@link module:ol/render/VectorContext VectorContext} that implements * direct rendering of features and geometries to an HTML5 Canvas context. * Instances of this class are created internally by the library and * provided to application code as vectorContext member of the - * {@link module:ol/render/Event~RenderEvent} object associated with postcompose, precompose and + * {@link module:ol/render/Event~RenderEvent RenderEvent} object associated with postcompose, precompose and * render events emitted by layers and maps. */ class CanvasImmediateRenderer extends VectorContext { @@ -541,7 +541,7 @@ class CanvasImmediateRenderer extends VectorContext { /** * Render a geometry into the canvas. Call - * {@link module:ol/render/canvas/Immediate#setStyle} first to set the rendering style. + * {@link module:ol/render/canvas/Immediate~CanvasImmediateRenderer#setStyle renderer.setStyle()} first to set the rendering style. * * @param {import("../../geom/Geometry.js").default|import("../Feature.js").default} geometry The geometry to render. * @api @@ -597,7 +597,7 @@ class CanvasImmediateRenderer extends VectorContext { * Render a feature into the canvas. Note that any `zIndex` on the provided * style will be ignored - features are rendered immediately in the order that * this method is called. If you need `zIndex` support, you should be using an - * {@link module:ol/layer/Vector~VectorLayer} instead. + * {@link module:ol/layer/Vector~VectorLayer VectorLayer} instead. * * @param {import("../../Feature.js").default} feature Feature. * @param {import("../../style/Style.js").default} style Style. diff --git a/src/ol/source/Vector.js b/src/ol/source/Vector.js index 7377025e89..bcc0f0ee2d 100644 --- a/src/ol/source/Vector.js +++ b/src/ol/source/Vector.js @@ -500,7 +500,7 @@ class VectorSource extends Source { /** * Remove all features from the source. - * @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#removefeature} events. + * @param {boolean} [opt_fast] Skip dispatching of {@link module:ol/source/Vector.VectorSourceEvent#event:removefeature removefeature} events. * @api */ clear(opt_fast) { diff --git a/src/ol/source/VectorEventType.js b/src/ol/source/VectorEventType.js index dbf5cead1a..a1d6016ad3 100644 --- a/src/ol/source/VectorEventType.js +++ b/src/ol/source/VectorEventType.js @@ -29,7 +29,7 @@ export default { /** * Triggered when a feature is removed from the source. - * See {@link module:ol/source/Vector#clear source.clear()} for exceptions. + * See {@link module:ol/source/Vector~VectorSource#clear source.clear()} for exceptions. * @event module:ol/source/Vector.VectorSourceEvent#removefeature * @api */