Mark optional property with square brackets

This commit is contained in:
Frederic Junod
2018-03-19 10:48:34 +01:00
parent 61f944d4a9
commit 0477f6cfdf
11 changed files with 37 additions and 43 deletions

View File

@@ -22,16 +22,14 @@ import {get as getProjection} from '../proj.js';
/**
* @typedef {Object} Options
* @property {module:ol/proj~ProjectionLike} defaultDataProjection Default data projection.
* Default is `EPSG:4326`.
* @property {module:ol/proj~ProjectionLike} featureProjection Projection for features read or
* @property {module:ol/proj~ProjectionLike} [defaultDataProjection='EPSG:4326'] Default data projection.
* @property {module:ol/proj~ProjectionLike} [featureProjection] Projection for features read or
* written by the format. Options passed to read or write methods will take precedence.
* @property {string|undefined} geometryName Geometry name to use when creating features.
* @property {boolean|undefined} extractGeometryName Certain GeoJSON providers include
* @property {string} [geometryName] Geometry name to use when creating features.
* @property {boolean} [extractGeometryName=false] Certain GeoJSON providers include
* the geometry_name field in the feature GeoJSON. If set to `true` the GeoJSON reader
* will look for that field to set the geometry name. If both this field is set to `true`
* and a `geometryName` is provided, the `geometryName` will take precedence.
* Default is `false`.
*/