Mark optional property with square brackets

This commit is contained in:
Frederic Junod
2018-03-15 15:20:01 +01:00
parent 218ca38f1d
commit 8a4d60192f
12 changed files with 36 additions and 45 deletions

View File

@@ -50,7 +50,7 @@ GEOMETRY_WRITERS[GeometryType.MULTI_POLYGON] = writeMultiPolygonGeometry;
/**
* @typedef {Object} Options
* @property {string|undefined} geometryName Geometry name to use when creating features.
* @property {string} [geometryName] Geometry name to use when creating features.
*/

View File

@@ -30,7 +30,7 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
* @property {ol.ProjectionLike} featureProjection Projection of the feature geometries
* that will be serialized by the format writer. If not provided, geometries are assumed
* to be in the `dataProjection` if that is set; in other words, they are not transformed.
* @property {boolean|undefined} rightHanded When writing geometries, follow the right-hand
* @property {boolean} [rightHanded] When writing geometries, follow the right-hand
* rule for linear ring orientation. This means that polygons will have counter-clockwise
* exterior rings and clockwise interior rings. By default, coordinates are serialized
* as they are provided at construction. If `true`, the right-hand rule will
@@ -38,7 +38,7 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
* exterior and counter-clockwise for interior rings). Note that not all
* formats support this. The GeoJSON format does use this property when writing
* geometries.
* @property {number|undefined} decimals Maximum number of decimal places for coordinates.
* @property {number} [decimals] Maximum number of decimal places for coordinates.
* Coordinates are stored internally as floats, but floating-point arithmetic can create
* coordinates with a large number of decimal places, not generally wanted on output.
* Set a number here to round coordinates. Can also be used to ensure that

View File

@@ -20,7 +20,7 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
/**
* @typedef {Object} Options
* @property {function(module:ol/Feature~Feature, Node)|undefined} readExtensions Callback function
* @property {function(module:ol/Feature~Feature, Node)} [readExtensions] Callback function
* to process `extensions` nodes. To prevent memory leaks, this callback function must
* not store any references to the node. Note that the `extensions`
* node is not allowed in GPX 1.0. Moreover, only `extensions`

View File

@@ -22,9 +22,8 @@ const IGCZ = {
/**
* @typedef {Object} Options
* @property {IGCZ|string|undefined} altitudeMode Altitude mode. Possible
* values are `'barometric'`, `'gps'`, and `'none'`. Default
* is `'none'`.
* @property {IGCZ|string} [altitudeMode='none'] Altitude mode. Possible
* values are `'barometric'`, `'gps'`, and `'none'`.
*/

View File

@@ -24,16 +24,16 @@ import RenderFeature from '../render/Feature.js';
/**
* @typedef {Object} Options
* @property {undefined|function((module:ol/geom/Geometry~Geometry|Object.<string,*>)=)|function(module:ol/geom/GeometryType~GeometryType,Array.<number>,(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)} featureClass
* @property {function((module:ol/geom/Geometry~Geometry|Object.<string,*>)=)|function(module:ol/geom/GeometryType~GeometryType,Array.<number>,(Array.<number>|Array.<Array.<number>>),Object.<string,*>,number)} [featureClass]
* Class for features returned by {@link ol.format.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 ol.render.Feature},
* which is optimized for rendering and hit detection.
* @property {string|undefined} geometryName Geometry name to use when creating
* features. Default is `'geometry'`.
* @property {string|undefined} layerName Name of the feature attribute that
* holds the layer name. Default is `'layer'`.
* @property {Array.<string>|undefined} layers Layers to read features from. If not
* @property {string} [geometryName='geometry'] Geometry name to use when creating
* features.
* @property {string} [layerName='layer'] Name of the feature attribute that
* holds the layer name.
* @property {Array.<string>} [layers] Layers to read features from. If not
* provided, features will be read from all layers.
*/

View File

@@ -19,8 +19,8 @@ import SimpleGeometry from '../geom/SimpleGeometry.js';
/**
* @typedef {Object} Options
* @property {boolean|undefined} splitCollection Whether to split GeometryCollections into
* multiple features on reading. Default is `false`.
* @property {boolean} [splitCollection=false] Whether to split GeometryCollections into
* multiple features on reading.
*/