Link to class instead of module pages

This commit is contained in:
Maximilian Krög
2022-02-14 21:53:07 +01:00
parent 924686ef71
commit b29ab8f104
33 changed files with 58 additions and 58 deletions

View File

@@ -47,7 +47,7 @@ import {containsExtent, getHeight, getWidth} from '../extent.js';
*
* If underlying map service is not using labels,
* take advantage of ol image caching and use
* {@link module:ol/source/TileArcGISRest} data source.
* {@link module:ol/source/TileArcGISRest~TileArcGISRest} data source.
*
* @fires module:ol/source/Image.ImageSourceEvent
* @api

View File

@@ -16,9 +16,9 @@ import {
* used by the source as an image. The arguments passed to the function are:
* {@link module:ol/extent~Extent} the image extent, `{number}` the image resolution,
* `{number}` the pixel ratio of the map, {@link module:ol/size~Size} the image size,
* and {@link module:ol/proj/Projection} the image projection. The canvas returned by
* and {@link module:ol/proj/Projection~Projection} the image projection. The canvas returned by
* this function is cached by the source. The this keyword inside the function
* references the {@link module:ol/source/ImageCanvas}.
* references the {@link module:ol/source/ImageCanvas~ImageCanvasSource}.
*
* @typedef {function(this:import("../ImageCanvas.js").default, import("../extent.js").Extent, number,
* number, import("../size.js").Size, import("../proj/Projection.js").default): HTMLCanvasElement} FunctionType

View File

@@ -23,7 +23,7 @@ import {getTileSetInfo} from './ogcTileUtil.js';
* stroke operations.
* @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection of the tile grid.
* @property {typeof import("../VectorTile.js").default} [tileClass] Class used to instantiate image tiles.
* Default is {@link module:ol/VectorTile}.
* Default is {@link module:ol/VectorTile~VectorTile}.
* @property {number} [transition] A duration for tile opacity
* transitions in milliseconds. A duration of 0 disables the opacity transition.
* @property {boolean} [wrapX=true] Whether to wrap the world horizontally.

View File

@@ -466,7 +466,7 @@ const RasterOperationType = {
/**
* @classdesc
* Events emitted by {@link module:ol/source/Raster} instances are instances of this
* Events emitted by {@link module:ol/source/Raster~RasterSource} instances are instances of this
* type.
*/
export class RasterSourceEvent extends Event {

View File

@@ -32,7 +32,7 @@ import {xhr} from '../featureloader.js';
/**
* @classdesc
* Events emitted by {@link module:ol/source/Vector} instances are instances of this
* Events emitted by {@link module:ol/source/Vector~VectorSource} instances are instances of this
* type.
* @template {import("../geom/Geometry.js").default} [Geometry=import("../geom/Geometry.js").default]
*/
@@ -74,7 +74,7 @@ export class VectorSourceEvent extends Event {
* @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {Array<import("../Feature.js").default>|Collection<import("../Feature.js").default>} [features]
* Features. If provided as {@link module:ol/Collection}, the features in the source
* Features. If provided as {@link module:ol/Collection~Collection}, the features in the source
* and the collection will stay in sync.
* @property {import("../format/Feature.js").default} [format] The feature format used by the XHR
* feature loader when `url` is set. Required if `url` is set, otherwise ignored.
@@ -155,7 +155,7 @@ export class VectorSourceEvent extends Event {
* through all features.
*
* When set to `false`, the features will be maintained in an
* {@link module:ol/Collection}, which can be retrieved through
* {@link module:ol/Collection~Collection}, which can be retrieved through
* {@link module:ol/source/Vector~VectorSource#getFeaturesCollection}.
* @property {boolean} [wrapX=true] Wrap the world horizontally. For vector editing across the
* -180° and 180° meridians to work properly, this should be set to `false`. The
@@ -756,7 +756,7 @@ class VectorSource extends Source {
* `useSpatialIndex` set to `false`.
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {function(import("../Feature.js").default<Geometry>):boolean} [opt_filter] Feature filter function.
* The filter function will receive one argument, the {@link module:ol/Feature feature}
* The filter function will receive one argument, the {@link module:ol/Feature~Feature feature}
* and it should return a boolean value. By default, no filtering is made.
* @return {import("../Feature.js").default<Geometry>} Closest feature.
* @api

View File

@@ -37,7 +37,7 @@ import {toSize} from '../size.js';
* @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection of the tile grid.
* @property {import("./State.js").default} [state] Source state.
* @property {typeof import("../VectorTile.js").default} [tileClass] Class used to instantiate image tiles.
* Default is {@link module:ol/VectorTile}.
* Default is {@link module:ol/VectorTile~VectorTile}.
* @property {number} [maxZoom=22] Optional max zoom level. Not used if `tileGrid` is provided.
* @property {number} [minZoom] Optional min zoom level. Not used if `tileGrid` is provided.
* @property {number|import("../size.js").Size} [tileSize=512] Optional tile size. Not used if `tileGrid` is provided.