ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mark optional property with square brackets

Browse Source
This commit is contained in:
Frederic Junod
2018-04-04 16:55:32 +02:00
parent 842cdcfcf7
commit 070f08e778
3 changed files with 31 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/ol/format/GMLBase.js
View File

@@ -31,7 +31,7 @@ export const GMLNS = 'http://www.opengis.net/gml';
/**
* @typedef {Object} Options
* @property {Object.<string, string>|string|undefined} featureNS Feature
* @property {Object.<string, string>|string} [featureNS] Feature
* namespace. If not defined will be derived from GML. If multiple
* feature types have been configured which come from different feature
* namespaces, this will be an object with the keys being the prefixes used
@@ -39,7 +39,7 @@ export const GMLNS = 'http://www.opengis.net/gml';
* feature namespaces themselves. So for instance there might be a featureType
* item `topp:states` in the `featureType` array and then there will be a key
* `topp` in the featureNS object with value `http://www.openplans.org/topp`.
* @property {Array.<string>|string|undefined} featureType Feature type(s) to parse.
* @property {Array.<string>|string} [featureType] Feature type(s) to parse.
* If multiple feature types need to be configured
* which come from different feature namespaces, `featureNS` will be an object
* with the keys being the prefixes used in the entries of featureType array.
@@ -48,15 +48,15 @@ export const GMLNS = 'http://www.opengis.net/gml';
* there will be a key named `topp` in the featureNS object with value
* `http://www.openplans.org/topp`.
* @property {string} srsName srsName to use when writing geometries.
* @property {boolean|undefined} surface Write gml:Surface instead of gml:Polygon
* elements. This also affects the elements in multi-part geometries. Default is `false`.
* @property {boolean|undefined} curve Write gml:Curve instead of gml:LineString
* elements. This also affects the elements in multi-part geometries. Default is `false`.
* @property {boolean|undefined} multiCurve Write gml:MultiCurve instead of gml:MultiLineString.
* Since the latter is deprecated in GML 3, the default is `true`.
* @property {boolean|undefined} multiSurface Write gml:multiSurface instead of
* gml:MultiPolygon. Since the latter is deprecated in GML 3, the default is `true`.
* @property {string|undefined} schemaLocation Optional schemaLocation to use when
* @property {boolean} [surface=false] Write gml:Surface instead of gml:Polygon
* elements. This also affects the elements in multi-part geometries.
* @property {boolean} [curve=false] Write gml:Curve instead of gml:LineString
* elements. This also affects the elements in multi-part geometries.
* @property {boolean} [multiCurve=true] Write gml:MultiCurve instead of gml:MultiLineString.
* Since the latter is deprecated in GML 3.
* @property {boolean} [multiSurface=true] Write gml:multiSurface instead of
* gml:MultiPolygon. Since the latter is deprecated in GML 3.
* @property {string} [schemaLocation] Optional schemaLocation to use when
* writing out the GML, this will override the default provided.
*/