Add descriptions for properties.

This commit is contained in:
Simon Seyock
2021-02-04 18:19:33 +01:00
parent 2fe91b8f4d
commit 2ad5789797
35 changed files with 232 additions and 232 deletions

View File

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

View File

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

View File

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

View File

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