diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index a7441f9502..54f1e34607 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -48,20 +48,20 @@ import {removeNode} from './dom.js'; * @property {number} pixelRatio The pixel ratio of the frame. * @property {number} time The time when rendering of the frame was requested. * @property {import("./View.js").State} viewState The state of the current view. - * @property {boolean} animate - * @property {import("./transform.js").Transform} coordinateToPixelTransform - * @property {import("rbush").default} declutterTree - * @property {null|import("./extent.js").Extent} extent - * @property {number} index - * @property {Array} layerStatesArray - * @property {number} layerIndex - * @property {import("./transform.js").Transform} pixelToCoordinateTransform - * @property {Array} postRenderFunctions - * @property {import("./size.js").Size} size - * @property {TileQueue} tileQueue - * @property {!Object>} usedTiles - * @property {Array} viewHints - * @property {!Object>} wantedTiles + * @property {boolean} animate Animate. + * @property {import("./transform.js").Transform} coordinateToPixelTransform CoordinateToPixelTransform. + * @property {import("rbush").default} declutterTree DeclutterTree. + * @property {null|import("./extent.js").Extent} extent Extent. + * @property {number} index Index. + * @property {Array} layerStatesArray LayerStatesArray. + * @property {number} layerIndex LayerIndex. + * @property {import("./transform.js").Transform} pixelToCoordinateTransform PixelToCoordinateTransform. + * @property {Array} postRenderFunctions PostRenderFunctions. + * @property {import("./size.js").Size} size Size. + * @property {TileQueue} tileQueue TileQueue. + * @property {!Object>} usedTiles UsedTiles. + * @property {Array} viewHints ViewHints. + * @property {!Object>} wantedTiles WantedTiles. */ /** @@ -83,11 +83,11 @@ import {removeNode} from './dom.js'; /** * @typedef {Object} MapOptionsInternal - * @property {Collection} [controls] - * @property {Collection} [interactions] - * @property {HTMLElement|Document} keyboardEventTarget - * @property {Collection} overlays - * @property {Object} values + * @property {Collection} [controls] Controls. + * @property {Collection} [interactions] Interactions. + * @property {HTMLElement|Document} keyboardEventTarget KeyboardEventTarget. + * @property {Collection} overlays Overlays. + * @property {Object} values Values. */ /** diff --git a/src/ol/VectorRenderTile.js b/src/ol/VectorRenderTile.js index 0902b92af5..7f771fcdde 100644 --- a/src/ol/VectorRenderTile.js +++ b/src/ol/VectorRenderTile.js @@ -7,14 +7,14 @@ import {getUid} from './util.js'; /** * @typedef {Object} ReplayState - * @property {boolean} dirty - * @property {null|import("./render.js").OrderFunction} renderedRenderOrder - * @property {number} renderedTileRevision - * @property {number} renderedResolution - * @property {number} renderedRevision - * @property {number} renderedZ - * @property {number} renderedTileResolution - * @property {number} renderedTileZ + * @property {boolean} dirty Dirty. + * @property {null|import("./render.js").OrderFunction} renderedRenderOrder RenderedRenderOrder. + * @property {number} renderedTileRevision RenderedTileRevision. + * @property {number} renderedResolution RenderedResolution. + * @property {number} renderedRevision RenderedRevision. + * @property {number} renderedZ RenderedZ. + * @property {number} renderedTileResolution RenderedTileResolution. + * @property {number} renderedTileZ RenderedTileZ. */ /** diff --git a/src/ol/View.js b/src/ol/View.js index 127a256241..23a04fb5c9 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -54,25 +54,25 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js'; * An animation configuration * * @typedef {Object} Animation - * @property {import("./coordinate.js").Coordinate} [sourceCenter] - * @property {import("./coordinate.js").Coordinate} [targetCenter] - * @property {number} [sourceResolution] - * @property {number} [targetResolution] - * @property {number} [sourceRotation] - * @property {number} [targetRotation] - * @property {import("./coordinate.js").Coordinate} [anchor] - * @property {number} start - * @property {number} duration - * @property {boolean} complete - * @property {function(number):number} easing - * @property {function(boolean):void} callback + * @property {import("./coordinate.js").Coordinate} [sourceCenter] Source center. + * @property {import("./coordinate.js").Coordinate} [targetCenter] Target center. + * @property {number} [sourceResolution] Source resolution. + * @property {number} [targetResolution] Target resolution. + * @property {number} [sourceRotation] Source rotation. + * @property {number} [targetRotation] Target rotation. + * @property {import("./coordinate.js").Coordinate} [anchor] Anchor. + * @property {number} start Start. + * @property {number} duration Duration. + * @property {boolean} complete Complete. + * @property {function(number):number} easing Easing. + * @property {function(boolean):void} callback Callback. */ /** * @typedef {Object} Constraints - * @property {import("./centerconstraint.js").Type} center - * @property {import("./resolutionconstraint.js").Type} resolution - * @property {import("./rotationconstraint.js").Type} rotation + * @property {import("./centerconstraint.js").Type} center Center. + * @property {import("./resolutionconstraint.js").Type} resolution Resolution. + * @property {import("./rotationconstraint.js").Type} rotation Rotation. */ /** @@ -203,11 +203,11 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js'; /** * @typedef {Object} State - * @property {import("./coordinate.js").Coordinate} center - * @property {import("./proj/Projection.js").default} projection - * @property {number} resolution - * @property {number} rotation - * @property {number} zoom + * @property {import("./coordinate.js").Coordinate} center Center. + * @property {import("./proj/Projection.js").default} projection Projection. + * @property {number} resolution Resolution. + * @property {number} rotation Rotation. + * @property {number} zoom Zoom. */ /** diff --git a/src/ol/css.js b/src/ol/css.js index b7eb38b0bf..76cadeb35c 100644 --- a/src/ol/css.js +++ b/src/ol/css.js @@ -4,13 +4,13 @@ /** * @typedef {Object} FontParameters - * @property {string} style - * @property {string} variant - * @property {string} weight - * @property {string} size - * @property {string} lineHeight - * @property {string} family - * @property {Array} families + * @property {string} style Style. + * @property {string} variant Variant. + * @property {string} weight Weight. + * @property {string} size Size. + * @property {string} lineHeight LineHeight. + * @property {string} family Family. + * @property {Array} families Families. */ /** diff --git a/src/ol/events.js b/src/ol/events.js index 7a150b78ba..c7b3e8db0d 100644 --- a/src/ol/events.js +++ b/src/ol/events.js @@ -6,9 +6,9 @@ import {clear} from './obj.js'; /** * Key to use with {@link module:ol/Observable~Observable#unByKey}. * @typedef {Object} EventsKey - * @property {ListenerFunction} listener - * @property {import("./events/Target.js").EventTargetLike} target - * @property {string} type + * @property {ListenerFunction} listener Listener. + * @property {import("./events/Target.js").EventTargetLike} target Target. + * @property {string} type Type. * @api */ @@ -22,7 +22,7 @@ import {clear} from './obj.js'; /** * @typedef {Object} ListenerObject - * @property {ListenerFunction} handleEvent + * @property {ListenerFunction} handleEvent HandleEvent listener function. */ /** diff --git a/src/ol/format/GPX.js b/src/ol/format/GPX.js index 1b105e6651..9ac50dc18b 100644 --- a/src/ol/format/GPX.js +++ b/src/ol/format/GPX.js @@ -109,8 +109,8 @@ const GPX_SERIALIZERS = makeStructureNS(NAMESPACE_URIS, { /** * @typedef {Object} LayoutOptions - * @property {boolean} [hasZ] - * @property {boolean} [hasM] + * @property {boolean} [hasZ] HasZ. + * @property {boolean} [hasM] HasM. */ /** diff --git a/src/ol/format/KML.js b/src/ol/format/KML.js index 9f98a5943c..e2c9e0dd2a 100644 --- a/src/ol/format/KML.js +++ b/src/ol/format/KML.js @@ -56,17 +56,17 @@ import {transformGeometryWithOptions} from './Feature.js'; /** * @typedef {Object} Vec2 - * @property {number} x - * @property {import("../style/IconAnchorUnits").default} xunits - * @property {number} y - * @property {import("../style/IconAnchorUnits").default} yunits - * @property {import("../style/IconOrigin.js").default} origin + * @property {number} x X coordinate. + * @property {import("../style/IconAnchorUnits").default} xunits Units of x. + * @property {number} y Y coordinate. + * @property {import("../style/IconAnchorUnits").default} yunits Units of Y. + * @property {import("../style/IconOrigin.js").default} origin Origin. */ /** * @typedef {Object} GxTrackObject - * @property {Array} flatCoordinates - * @property {Array} whens + * @property {Array} flatCoordinates Flat coordinates. + * @property {Array} whens Whens. */ /** diff --git a/src/ol/format/WFS.js b/src/ol/format/WFS.js index a358f0ce77..12f76c44df 100644 --- a/src/ol/format/WFS.js +++ b/src/ol/format/WFS.js @@ -178,17 +178,17 @@ const TRANSACTION_SERIALIZERS = { /** * Number of features; bounds/extent. * @typedef {Object} FeatureCollectionMetadata - * @property {number} numberOfFeatures - * @property {import("../extent.js").Extent} bounds + * @property {number} numberOfFeatures NumberOfFeatures. + * @property {import("../extent.js").Extent} bounds Bounds. */ /** * Total deleted; total inserted; total updated; array of insert ids. * @typedef {Object} TransactionResponse - * @property {number} totalDeleted - * @property {number} totalInserted - * @property {number} totalUpdated - * @property {Array} insertIds + * @property {number} totalDeleted TotalDeleted. + * @property {number} totalInserted TotalInserted. + * @property {number} totalUpdated TotalUpdated. + * @property {Array} insertIds InsertIds. */ /** diff --git a/src/ol/format/WKT.js b/src/ol/format/WKT.js index f2ee8ebc9f..f15b406d2b 100644 --- a/src/ol/format/WKT.js +++ b/src/ol/format/WKT.js @@ -35,9 +35,9 @@ const GeometryConstructor = { /** * @typedef {Object} Token - * @property {number} type - * @property {number|string} [value] - * @property {number} position + * @property {number} type Type. + * @property {number|string} [value] Value. + * @property {number} position Position. */ /** diff --git a/src/ol/interaction/Modify.js b/src/ol/interaction/Modify.js index e42571a09e..f0300ca116 100644 --- a/src/ol/interaction/Modify.js +++ b/src/ol/interaction/Modify.js @@ -81,12 +81,12 @@ const ModifyEventType = { /** * @typedef {Object} SegmentData - * @property {Array} [depth] - * @property {Feature} feature - * @property {import("../geom/SimpleGeometry.js").default} geometry - * @property {number} [index] - * @property {Array} segment - * @property {Array} [featureSegments] + * @property {Array} [depth] Depth. + * @property {Feature} feature Feature. + * @property {import("../geom/SimpleGeometry.js").default} geometry Geometry. + * @property {number} [index] Index. + * @property {Array} segment Segment. + * @property {Array} [featureSegments] FeatureSegments. */ /** diff --git a/src/ol/interaction/Snap.js b/src/ol/interaction/Snap.js index 5ea6945a95..f3b29ce299 100644 --- a/src/ol/interaction/Snap.js +++ b/src/ol/interaction/Snap.js @@ -28,15 +28,15 @@ import {listen, unlistenByKey} from '../events.js'; /** * @typedef {Object} Result - * @property {boolean} snapped - * @property {import("../coordinate.js").Coordinate|null} vertex - * @property {import("../pixel.js").Pixel|null} vertexPixel + * @property {boolean} snapped Snapped. + * @property {import("../coordinate.js").Coordinate|null} vertex Vertex. + * @property {import("../pixel.js").Pixel|null} vertexPixel VertexPixel. */ /** * @typedef {Object} SegmentData - * @property {import("../Feature.js").default} feature - * @property {Array} segment + * @property {import("../Feature.js").default} feature Feature. + * @property {Array} segment Segment. */ /** diff --git a/src/ol/layer/Graticule.js b/src/ol/layer/Graticule.js index fba118c66c..7d0fbaf0ce 100644 --- a/src/ol/layer/Graticule.js +++ b/src/ol/layer/Graticule.js @@ -72,8 +72,8 @@ const INTERVALS = [ /** * @typedef {Object} GraticuleLabelDataType - * @property {Point} geom - * @property {string} text + * @property {Point} geom Geometry. + * @property {string} text Text. */ /** diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index e55944faad..14448b239f 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -44,17 +44,17 @@ import {listen, unlistenByKey} from '../events.js'; /** * @typedef {Object} State - * @property {import("./Layer.js").default} layer + * @property {import("./Layer.js").default} layer Layer. * @property {number} opacity Opacity, the value is rounded to two digits to appear after the decimal point. - * @property {import("../source/State.js").default} sourceState - * @property {boolean} visible - * @property {boolean} managed - * @property {import("../extent.js").Extent} [extent] - * @property {number} zIndex - * @property {number} maxResolution - * @property {number} minResolution - * @property {number} minZoom - * @property {number} maxZoom + * @property {import("../source/State.js").default} sourceState SourceState. + * @property {boolean} visible Visible. + * @property {boolean} managed Managed. + * @property {import("../extent.js").Extent} [extent] Extent. + * @property {number} zIndex ZIndex. + * @property {number} maxResolution Maximum resolution. + * @property {number} minResolution Minimum resolution. + * @property {number} minZoom Minimum zoom. + * @property {number} maxZoom Maximum zoom. */ /** diff --git a/src/ol/render.js b/src/ol/render.js index 67c36960d2..150c8809a3 100644 --- a/src/ol/render.js +++ b/src/ol/render.js @@ -15,8 +15,8 @@ import {getTransformFromProjections, getUserProjection} from './proj.js'; /** * @typedef {Object} State * @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to. - * @property {import("./Feature.js").FeatureLike} feature - * @property {import("./geom/SimpleGeometry.js").default} geometry + * @property {import("./Feature.js").FeatureLike} feature Feature. + * @property {import("./geom/SimpleGeometry.js").default} geometry Geometry. * @property {number} pixelRatio Pixel ratio used by the layer renderer. * @property {number} resolution Resolution that the render batch was created and optimized for. * This is not the view's resolution that is being rendered. diff --git a/src/ol/render/canvas.js b/src/ol/render/canvas.js index b5ff8eb574..61780050a9 100644 --- a/src/ol/render/canvas.js +++ b/src/ol/render/canvas.js @@ -11,60 +11,60 @@ import {toString} from '../transform.js'; /** * @typedef {Object} FillState - * @property {import("../colorlike.js").ColorLike} fillStyle + * @property {import("../colorlike.js").ColorLike} fillStyle FillStyle. */ /** * @typedef Label - * @property {number} width - * @property {number} height - * @property {Array} contextInstructions + * @property {number} width Width. + * @property {number} height Height. + * @property {Array} contextInstructions ContextInstructions. */ /** * @typedef {Object} FillStrokeState - * @property {import("../colorlike.js").ColorLike} [currentFillStyle] - * @property {import("../colorlike.js").ColorLike} [currentStrokeStyle] - * @property {CanvasLineCap} [currentLineCap] - * @property {Array} currentLineDash - * @property {number} [currentLineDashOffset] - * @property {CanvasLineJoin} [currentLineJoin] - * @property {number} [currentLineWidth] - * @property {number} [currentMiterLimit] - * @property {number} [lastStroke] - * @property {import("../colorlike.js").ColorLike} [fillStyle] - * @property {import("../colorlike.js").ColorLike} [strokeStyle] - * @property {CanvasLineCap} [lineCap] - * @property {Array} lineDash - * @property {number} [lineDashOffset] - * @property {CanvasLineJoin} [lineJoin] - * @property {number} [lineWidth] - * @property {number} [miterLimit] + * @property {import("../colorlike.js").ColorLike} [currentFillStyle] Current FillStyle. + * @property {import("../colorlike.js").ColorLike} [currentStrokeStyle] Current StrokeStyle. + * @property {CanvasLineCap} [currentLineCap] Current LineCap. + * @property {Array} currentLineDash Current LineDash. + * @property {number} [currentLineDashOffset] Current LineDashOffset. + * @property {CanvasLineJoin} [currentLineJoin] Current LineJoin. + * @property {number} [currentLineWidth] Current LineWidth. + * @property {number} [currentMiterLimit] Current MiterLimit. + * @property {number} [lastStroke] Last stroke. + * @property {import("../colorlike.js").ColorLike} [fillStyle] FillStyle. + * @property {import("../colorlike.js").ColorLike} [strokeStyle] StrokeStyle. + * @property {CanvasLineCap} [lineCap] LineCap. + * @property {Array} lineDash LineDash. + * @property {number} [lineDashOffset] LineDashOffset. + * @property {CanvasLineJoin} [lineJoin] LineJoin. + * @property {number} [lineWidth] LineWidth. + * @property {number} [miterLimit] MiterLimit. */ /** * @typedef {Object} StrokeState - * @property {CanvasLineCap} lineCap - * @property {Array} lineDash - * @property {number} lineDashOffset - * @property {CanvasLineJoin} lineJoin - * @property {number} lineWidth - * @property {number} miterLimit - * @property {import("../colorlike.js").ColorLike} strokeStyle + * @property {CanvasLineCap} lineCap LineCap. + * @property {Array} lineDash LineDash. + * @property {number} lineDashOffset LineDashOffset. + * @property {CanvasLineJoin} lineJoin LineJoin. + * @property {number} lineWidth LineWidth. + * @property {number} miterLimit MiterLimit. + * @property {import("../colorlike.js").ColorLike} strokeStyle StrokeStyle. */ /** * @typedef {Object} TextState - * @property {string} font - * @property {string} [textAlign] - * @property {string} textBaseline - * @property {string} [placement] - * @property {number} [maxAngle] - * @property {boolean} [overflow] - * @property {import("../style/Fill.js").default} [backgroundFill] - * @property {import("../style/Stroke.js").default} [backgroundStroke] - * @property {import("../size.js").Size} [scale] - * @property {Array} [padding] + * @property {string} font Font. + * @property {string} [textAlign] TextAlign. + * @property {string} textBaseline TextBaseline. + * @property {string} [placement] Placement. + * @property {number} [maxAngle] MaxAngle. + * @property {boolean} [overflow] Overflow. + * @property {import("../style/Fill.js").default} [backgroundFill] BackgroundFill. + * @property {import("../style/Stroke.js").default} [backgroundStroke] BackgroundStroke. + * @property {import("../size.js").Size} [scale] Scale. + * @property {Array} [padding] Padding. */ /** diff --git a/src/ol/render/canvas/Executor.js b/src/ol/render/canvas/Executor.js index b5da8e92af..813a94324f 100644 --- a/src/ol/render/canvas/Executor.js +++ b/src/ol/render/canvas/Executor.js @@ -29,24 +29,24 @@ import {transform2D} from '../../geom/flat/transform.js'; /** * @typedef {Object} BBox - * @property {number} minX - * @property {number} minY - * @property {number} maxX - * @property {number} maxY - * @property {*} value + * @property {number} minX Minimal x. + * @property {number} minY Minimal y. + * @property {number} maxX Maximal x. + * @property {number} maxY Maximal y + * @property {*} value Value. */ /** * @typedef {Object} ImageOrLabelDimensions - * @property {number} drawImageX - * @property {number} drawImageY - * @property {number} drawImageW - * @property {number} drawImageH - * @property {number} originX - * @property {number} originY - * @property {Array} scale - * @property {BBox} declutterBox - * @property {import("../../transform.js").Transform} canvasTransform + * @property {number} drawImageX DrawImageX. + * @property {number} drawImageY DrawImageY. + * @property {number} drawImageW DrawImageW. + * @property {number} drawImageH DrawImageH. + * @property {number} originX OriginX. + * @property {number} originY OriginY. + * @property {Array} scale Scale. + * @property {BBox} declutterBox DeclutterBox. + * @property {import("../../transform.js").Transform} canvasTransform CanvasTransform. */ /** diff --git a/src/ol/renderer/Map.js b/src/ol/renderer/Map.js index dc777be439..d663541cd9 100644 --- a/src/ol/renderer/Map.js +++ b/src/ol/renderer/Map.js @@ -12,11 +12,11 @@ import {wrapX} from '../coordinate.js'; /** * @typedef HitMatch - * @property {import("../Feature.js").FeatureLike} feature - * @property {import("../layer/Layer.js").default} layer - * @property {import("../geom/SimpleGeometry.js").default} geometry - * @property {number} distanceSq - * @property {import("./vector.js").FeatureCallback} callback + * @property {import("../Feature.js").FeatureLike} feature Feature. + * @property {import("../layer/Layer.js").default} layer Layer. + * @property {import("../geom/SimpleGeometry.js").default} geometry Geometry. + * @property {number} distanceSq Squared distance. + * @property {import("./vector.js").FeatureCallback} callback Callback. * @template T */ diff --git a/src/ol/reproj.js b/src/ol/reproj.js index 6dd6b72228..00f9536c99 100644 --- a/src/ol/reproj.js +++ b/src/ol/reproj.js @@ -180,8 +180,8 @@ export function calculateSourceExtentResolution( /** * @typedef {Object} ImageExtent - * @property {import("./extent.js").Extent} extent - * @property {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image + * @property {import("./extent.js").Extent} extent Extent. + * @property {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image. */ /** diff --git a/src/ol/reproj/Triangulation.js b/src/ol/reproj/Triangulation.js index da7f70ead7..15dfacdb13 100644 --- a/src/ol/reproj/Triangulation.js +++ b/src/ol/reproj/Triangulation.js @@ -19,8 +19,8 @@ import {log2, modulo} from '../math.js'; /** * Single triangle; consists of 3 source points and 3 target points. * @typedef {Object} Triangle - * @property {Array} source - * @property {Array} target + * @property {Array} source Source. + * @property {Array} target Target. */ /** diff --git a/src/ol/source/BingMaps.js b/src/ol/source/BingMaps.js index ef0836f7a1..fc41d162ab 100644 --- a/src/ol/source/BingMaps.js +++ b/src/ol/source/BingMaps.js @@ -78,7 +78,7 @@ const TOS_ATTRIBUTION = /** * @typedef {Object} ResourceSet - * @property {Array} resources + * @property {Array} resources Resources. */ /** diff --git a/src/ol/source/IIIF.js b/src/ol/source/IIIF.js index 162b16dd01..8d86c2f368 100644 --- a/src/ol/source/IIIF.js +++ b/src/ol/source/IIIF.js @@ -16,12 +16,12 @@ import {toSize} from '../size.js'; * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. - * @property {number} [cacheSize] - * @property {null|string} [crossOrigin] - * @property {import("../extent.js").Extent} [extent=[0, -height, width, 0]] + * @property {number} [cacheSize] Size of the cache. + * @property {null|string} [crossOrigin] The value for the crossOrigin option of the request. + * @property {import("../extent.js").Extent} [extent=[0, -height, width, 0]] The extent. * @property {string} [format='jpg'] Requested image format. * @property {boolean} [imageSmoothing=true] Enable image smoothing. - * @property {import("../proj.js").ProjectionLike} [projection] + * @property {import("../proj.js").ProjectionLike} [projection] Projection. * @property {string} [quality] Requested IIIF image quality. Default is 'native' * for version 1, 'default' for versions 2 and 3. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). @@ -33,13 +33,13 @@ import {toSize} from '../size.js'; * @property {import("./State.js").default} [state] Source state. * @property {Array} [supports=[]] Supported IIIF region and size calculation * features. - * @property {number} [tilePixelRatio] + * @property {number} [tilePixelRatio] Tile pixel ratio. * @property {number|import("../size.js").Size} [tileSize] Tile size. * Same tile size is used for all zoom levels. If tile size is a number, * a square tile is assumed. If the IIIF image service supports arbitrary * tiling (sizeByH, sizeByW, sizeByWh or sizeByPct as well as regionByPx or regionByPct * are supported), the default tilesize is 256. - * @property {number} [transition] + * @property {number} [transition] Transition. * @property {string} [url] Base URL of the IIIF Image service. * This should be the same as the IIIF Image ID. * @property {import("../format/IIIFInfo.js").Versions} [version=Versions.VERSION2] Service's IIIF Image API version. diff --git a/src/ol/source/Image.js b/src/ol/source/Image.js index 2c62214b1b..6ab9754ec6 100644 --- a/src/ol/source/Image.js +++ b/src/ol/source/Image.js @@ -62,11 +62,11 @@ export class ImageSourceEvent extends Event { /** * @typedef {Object} Options - * @property {import("./Source.js").AttributionLike} [attributions] + * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {boolean} [imageSmoothing=true] Enable image smoothing. - * @property {import("../proj.js").ProjectionLike} [projection] - * @property {Array} [resolutions] - * @property {import("./State.js").default} [state] + * @property {import("../proj.js").ProjectionLike} [projection] Projection. + * @property {Array} [resolutions] Resolutions. + * @property {import("./State.js").default} [state] State. */ /** diff --git a/src/ol/source/Source.js b/src/ol/source/Source.js index af2898cfec..cd07fc14b2 100644 --- a/src/ol/source/Source.js +++ b/src/ol/source/Source.js @@ -26,11 +26,11 @@ import {get as getProjection} from '../proj.js'; /** * @typedef {Object} Options - * @property {AttributionLike} [attributions] + * @property {AttributionLike} [attributions] Attributions. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection. - * @property {import("./State.js").default} [state='ready'] - * @property {boolean} [wrapX=false] + * @property {import("./State.js").default} [state='ready'] State. + * @property {boolean} [wrapX=false] WrapX. */ /** diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js index 90ab003a23..7e9036fe83 100644 --- a/src/ol/source/Tile.js +++ b/src/ol/source/Tile.js @@ -17,18 +17,18 @@ import {scale as scaleSize, toSize} from '../size.js'; /** * @typedef {Object} Options - * @property {import("./Source.js").AttributionLike} [attributions] + * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. - * @property {number} [cacheSize] + * @property {number} [cacheSize] CacheSize. * @property {boolean} [opaque=false] Whether the layer is opaque. - * @property {number} [tilePixelRatio] - * @property {import("../proj.js").ProjectionLike} [projection] - * @property {import("./State.js").default} [state] - * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] - * @property {boolean} [wrapX=true] - * @property {number} [transition] - * @property {string} [key] - * @property {number} [zDirection=0] + * @property {number} [tilePixelRatio] TilePixelRatio. + * @property {import("../proj.js").ProjectionLike} [projection] Projection. + * @property {import("./State.js").default} [state] State. + * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] TileGrid. + * @property {boolean} [wrapX=true] WrapX. + * @property {number} [transition] Transition. + * @property {string} [key] Key. + * @property {number} [zDirection=0] ZDirection. */ /** diff --git a/src/ol/source/UrlTile.js b/src/ol/source/UrlTile.js index 6351fd7c41..d049731fdd 100644 --- a/src/ol/source/UrlTile.js +++ b/src/ol/source/UrlTile.js @@ -10,22 +10,22 @@ import {getUid} from '../util.js'; /** * @typedef {Object} Options - * @property {import("./Source.js").AttributionLike} [attributions] + * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. - * @property {number} [cacheSize] + * @property {number} [cacheSize] Cache size. * @property {boolean} [opaque=false] Whether the layer is opaque. - * @property {import("../proj.js").ProjectionLike} [projection] - * @property {import("./State.js").default} [state] - * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] - * @property {import("../Tile.js").LoadFunction} tileLoadFunction - * @property {number} [tilePixelRatio] - * @property {import("../Tile.js").UrlFunction} [tileUrlFunction] - * @property {string} [url] - * @property {Array} [urls] - * @property {boolean} [wrapX=true] - * @property {number} [transition] - * @property {string} [key] - * @property {number} [zDirection=0] + * @property {import("../proj.js").ProjectionLike} [projection] Projection. + * @property {import("./State.js").default} [state] State. + * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] TileGrid. + * @property {import("../Tile.js").LoadFunction} tileLoadFunction TileLoadFunction. + * @property {number} [tilePixelRatio] TilePixelRatio. + * @property {import("../Tile.js").UrlFunction} [tileUrlFunction] TileUrlFunction. + * @property {string} [url] Url. + * @property {Array} [urls] Urls. + * @property {boolean} [wrapX=true] WrapX. + * @property {number} [transition] Transition. + * @property {string} [key] Key. + * @property {number} [zDirection=0] ZDirection. */ /** diff --git a/src/ol/source/VectorTile.js b/src/ol/source/VectorTile.js index a4f6b467f8..f9e9ed77bc 100644 --- a/src/ol/source/VectorTile.js +++ b/src/ol/source/VectorTile.js @@ -28,7 +28,7 @@ import {toSize} from '../size.js'; * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least twice the number of tiles in the viewport. - * @property {import("../extent.js").Extent} [extent] + * @property {import("../extent.js").Extent} [extent] Extent. * @property {import("../format/Feature.js").default} [format] Feature format for tiles. Used and required by the default. * @property {boolean} [overlaps=true] This source may have overlapping geometries. Setting this * to `false` (e.g. for sources with polygons that represent administrative diff --git a/src/ol/source/Zoomify.js b/src/ol/source/Zoomify.js index ae7c950d8b..eba71977d5 100644 --- a/src/ol/source/Zoomify.js +++ b/src/ol/source/Zoomify.js @@ -104,7 +104,7 @@ export class CustomTile extends ImageTile { * A `{?-?}` template pattern, for example `subdomain{a-f}.domain.com`, may be * used instead of defining each one separately in the `urls` option. * @property {string} [tierSizeCalculation] Tier size calculation method: `default` or `truncated`. - * @property {import("../size.js").Size} size + * @property {import("../size.js").Size} size Size. * @property {import("../extent.js").Extent} [extent] Extent for the TileGrid that is created. * Default sets the TileGrid in the * fourth quadrant, meaning extent is `[0, -height, width, 0]`. To change the diff --git a/src/ol/structs/LRUCache.js b/src/ol/structs/LRUCache.js index ae8a024c4b..e8e3b42343 100644 --- a/src/ol/structs/LRUCache.js +++ b/src/ol/structs/LRUCache.js @@ -6,10 +6,10 @@ import {assert} from '../asserts.js'; /** * @typedef {Object} Entry - * @property {string} key_ - * @property {Object} newer - * @property {Object} older - * @property {*} value_ + * @property {string} key_ Key. + * @property {Object} newer Newer. + * @property {Object} older Older. + * @property {*} value_ Value. */ /** diff --git a/src/ol/structs/LinkedList.js b/src/ol/structs/LinkedList.js index 09e53b4506..3920259a11 100644 --- a/src/ol/structs/LinkedList.js +++ b/src/ol/structs/LinkedList.js @@ -4,9 +4,9 @@ /** * @typedef {Object} Item - * @property {Item} [prev] - * @property {Item} [next] - * @property {?} data + * @property {Item} [prev] Previous. + * @property {Item} [next] Next. + * @property {?} data Data. */ /** diff --git a/src/ol/structs/RBush.js b/src/ol/structs/RBush.js index a9d7dc5b4e..1be15b420c 100644 --- a/src/ol/structs/RBush.js +++ b/src/ol/structs/RBush.js @@ -8,11 +8,11 @@ import {isEmpty} from '../obj.js'; /** * @typedef {Object} Entry - * @property {number} minX - * @property {number} minY - * @property {number} maxX - * @property {number} maxY - * @property {Object} [value] + * @property {number} minX MinX. + * @property {number} minY MinY. + * @property {number} maxX MaxX. + * @property {number} maxY MaxY. + * @property {Object} [value] Value. */ /** diff --git a/src/ol/style/Image.js b/src/ol/style/Image.js index 32e8810574..f481c888ac 100644 --- a/src/ol/style/Image.js +++ b/src/ol/style/Image.js @@ -6,11 +6,11 @@ import {toSize} from '../size.js'; /** * @typedef {Object} Options - * @property {number} opacity - * @property {boolean} rotateWithView - * @property {number} rotation - * @property {number|import("../size.js").Size} scale - * @property {Array} displacement + * @property {number} opacity Opacity. + * @property {boolean} rotateWithView If the image should get rotated with the view. + * @property {number} rotation Rotation. + * @property {number|import("../size.js").Size} scale Scale. + * @property {Array} displacement Displacement. */ /** diff --git a/src/ol/style/RegularShape.js b/src/ol/style/RegularShape.js index 6522fdb0d3..0d5452228d 100644 --- a/src/ol/style/RegularShape.js +++ b/src/ol/style/RegularShape.js @@ -36,14 +36,14 @@ import { /** * @typedef {Object} RenderOptions - * @property {import("../colorlike.js").ColorLike} [strokeStyle] - * @property {number} strokeWidth - * @property {number} size - * @property {CanvasLineCap} lineCap - * @property {Array} lineDash - * @property {number} lineDashOffset - * @property {CanvasLineJoin} lineJoin - * @property {number} miterLimit + * @property {import("../colorlike.js").ColorLike} [strokeStyle] StrokeStyle. + * @property {number} strokeWidth StrokeWidth. + * @property {number} size Size. + * @property {CanvasLineCap} lineCap LineCap. + * @property {Array} lineDash LineDash. + * @property {number} lineDashOffset LineDashOffset. + * @property {CanvasLineJoin} lineJoin LineJoin. + * @property {number} miterLimit MiterLimit. */ /** diff --git a/src/ol/webgl/Helper.js b/src/ol/webgl/Helper.js index 39d65b33dd..7334355dc8 100644 --- a/src/ol/webgl/Helper.js +++ b/src/ol/webgl/Helper.js @@ -27,8 +27,8 @@ import {includes} from '../array.js'; /** * @typedef {Object} BufferCacheEntry - * @property {import("./Buffer.js").default} buffer - * @property {WebGLBuffer} webGlBuffer + * @property {import("./Buffer.js").default} buffer Buffer. + * @property {WebGLBuffer} webGlBuffer WebGlBuffer. */ /** diff --git a/src/ol/xml.js b/src/ol/xml.js index 40cf9765bb..c9650bac64 100644 --- a/src/ol/xml.js +++ b/src/ol/xml.js @@ -8,7 +8,7 @@ import {extend} from './array.js'; * {@link module:ol/xml~makeSimpleNodeFactory}, the top `objectStack` item needs * to have this structure. * @typedef {Object} NodeStackItem - * @property {Node} node + * @property {Node} node Node. */ /** diff --git a/test/test-extensions.js b/test/test-extensions.js index 5120a28f36..fcace986ae 100644 --- a/test/test-extensions.js +++ b/test/test-extensions.js @@ -333,8 +333,8 @@ /** * @typedef {Object} XMLEqlOptions - * @property {boolean} [includeWhiteSpace] - * @property {boolean} [ignoreElementOrder] + * @property {boolean} [includeWhiteSpace] IncludeWhiteSpace. + * @property {boolean} [ignoreElementOrder] IgnoreElementOrder. */ /**