Merge pull request #11981 from simonseyock/property-description

Add descriptions for properties.

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<import("./layer/Layer.js").State>} layerStatesArray
- * @property {number} layerIndex
- * @property {import("./transform.js").Transform} pixelToCoordinateTransform
- * @property {Array<PostRenderFunction>} postRenderFunctions
- * @property {import("./size.js").Size} size
- * @property {TileQueue} tileQueue
- * @property {!Object<string, Object<string, boolean>>} usedTiles
- * @property {Array<number>} viewHints
- * @property {!Object<string, Object<string, boolean>>} 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<import("./layer/Layer.js").State>} layerStatesArray LayerStatesArray.
+ * @property {number} layerIndex LayerIndex.
+ * @property {import("./transform.js").Transform} pixelToCoordinateTransform PixelToCoordinateTransform.
+ * @property {Array<PostRenderFunction>} postRenderFunctions PostRenderFunctions.
+ * @property {import("./size.js").Size} size Size.
+ * @property {TileQueue} tileQueue TileQueue.
+ * @property {!Object<string, Object<string, boolean>>} usedTiles UsedTiles.
+ * @property {Array<number>} viewHints ViewHints.
+ * @property {!Object<string, Object<string, boolean>>} wantedTiles WantedTiles.
  */
 
 /**
@@ -83,11 +83,11 @@ import {removeNode} from './dom.js';
 
 /**
  * @typedef {Object} MapOptionsInternal
- * @property {Collection<import("./control/Control.js").default>} [controls]
- * @property {Collection<import("./interaction/Interaction.js").default>} [interactions]
- * @property {HTMLElement|Document} keyboardEventTarget
- * @property {Collection<import("./Overlay.js").default>} overlays
- * @property {Object<string, *>} values
+ * @property {Collection<import("./control/Control.js").default>} [controls] Controls.
+ * @property {Collection<import("./interaction/Interaction.js").default>} [interactions] Interactions.
+ * @property {HTMLElement|Document} keyboardEventTarget KeyboardEventTarget.
+ * @property {Collection<import("./Overlay.js").default>} overlays Overlays.
+ * @property {Object<string, *>} values Values.
  */
 
 /**

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

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

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<string>} 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<string>} families Families.
  */
 
 /**

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

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

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<number>} flatCoordinates
- * @property {Array<number>} whens
+ * @property {Array<number>} flatCoordinates Flat coordinates.
+ * @property {Array<number>} whens Whens.
  */
 
 /**

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<string>} insertIds
+ * @property {number} totalDeleted TotalDeleted.
+ * @property {number} totalInserted TotalInserted.
+ * @property {number} totalUpdated TotalUpdated.
+ * @property {Array<string>} insertIds InsertIds.
  */
 
 /**

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

src/ol/interaction/Modify.js

@@ -81,12 +81,12 @@ const ModifyEventType = {
 
 /**
  * @typedef {Object} SegmentData
- * @property {Array<number>} [depth]
- * @property {Feature} feature
- * @property {import("../geom/SimpleGeometry.js").default} geometry
- * @property {number} [index]
- * @property {Array<import("../extent.js").Extent>} segment
- * @property {Array<SegmentData>} [featureSegments]
+ * @property {Array<number>} [depth] Depth.
+ * @property {Feature} feature Feature.
+ * @property {import("../geom/SimpleGeometry.js").default} geometry Geometry.
+ * @property {number} [index] Index.
+ * @property {Array<import("../extent.js").Extent>} segment Segment.
+ * @property {Array<SegmentData>} [featureSegments] FeatureSegments.
  */
 
 /**

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<import("../coordinate.js").Coordinate>} segment
+ * @property {import("../Feature.js").default} feature Feature.
+ * @property {Array<import("../coordinate.js").Coordinate>} segment Segment.
  */
 
 /**

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

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

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.

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<string|number>} contextInstructions
+ * @property {number} width Width.
+ * @property {number} height Height.
+ * @property {Array<string|number>} contextInstructions ContextInstructions.
  */
 
 /**
  * @typedef {Object} FillStrokeState
- * @property {import("../colorlike.js").ColorLike} [currentFillStyle]
- * @property {import("../colorlike.js").ColorLike} [currentStrokeStyle]
- * @property {CanvasLineCap} [currentLineCap]
- * @property {Array<number>} 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<number>} 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<number>} 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<number>} 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<number>} 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<number>} 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<number>} [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<number>} [padding] Padding.
  */
 
 /**

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<number>} 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<number>} scale Scale.
+ * @property {BBox} declutterBox DeclutterBox.
+ * @property {import("../../transform.js").Transform} canvasTransform CanvasTransform.
  */
 
 /**

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<T>} 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<T>} callback Callback.
  * @template T
  */
 

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

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<import("../coordinate.js").Coordinate>} source
- * @property {Array<import("../coordinate.js").Coordinate>} target
+ * @property {Array<import("../coordinate.js").Coordinate>} source Source.
+ * @property {Array<import("../coordinate.js").Coordinate>} target Target.
  */
 
 /**

src/ol/source/BingMaps.js

@@ -78,7 +78,7 @@ const TOS_ATTRIBUTION =
 
 /**
  * @typedef {Object} ResourceSet
- * @property {Array<Resource>} resources
+ * @property {Array<Resource>} resources Resources.
  */
 
 /**

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<string>} [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.

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<number>} [resolutions]
- * @property {import("./State.js").default} [state]
+ * @property {import("../proj.js").ProjectionLike} [projection] Projection.
+ * @property {Array<number>} [resolutions] Resolutions.
+ * @property {import("./State.js").default} [state] State.
  */
 
 /**

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

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

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<string>} [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<string>} [urls] Urls.
+ * @property {boolean} [wrapX=true] WrapX.
+ * @property {number} [transition] Transition.
+ * @property {string} [key] Key.
+ * @property {number} [zDirection=0] ZDirection.
  */
 
 /**

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

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

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

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

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

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<number>} 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<number>} displacement Displacement.
  */
 
 /**

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<number>} 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<number>} lineDash LineDash.
+ * @property {number} lineDashOffset LineDashOffset.
+ * @property {CanvasLineJoin} lineJoin LineJoin.
+ * @property {number} miterLimit MiterLimit.
  */
 
 /**

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

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

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