diff --git a/src/ol/format/GMLBase.js b/src/ol/format/GMLBase.js index 60bf76b878..75239d77bf 100644 --- a/src/ol/format/GMLBase.js +++ b/src/ol/format/GMLBase.js @@ -31,7 +31,7 @@ export const GMLNS = 'http://www.opengis.net/gml'; /** * @typedef {Object} Options - * @property {Object.|string|undefined} featureNS Feature + * @property {Object.|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|undefined} featureType Feature type(s) to parse. + * @property {Array.|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. */ diff --git a/src/ol/format/WFS.js b/src/ol/format/WFS.js index 11eb0c883d..3352a6a290 100644 --- a/src/ol/format/WFS.js +++ b/src/ol/format/WFS.js @@ -19,14 +19,10 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender, /** * @typedef {Object} Options - * @property {Object.|string|undefined} featureNS The namespace - * URI used for features. - * @property {Array.|string|undefined} featureType The feature type to parse. - * Only used for read operations. - * @property {ol.format.GMLBase|undefined} gmlFormat The GML format to use to parse - * the response. Default is `ol.format.GML3`. - * @property {string|undefined} schemaLocation Optional schemaLocation to use for - * serialization, this will override the default. + * @property {Object.|string} [featureNS] The namespace URI used for features. + * @property {Array.|string} [featureType] The feature type to parse. Only used for read operations. + * @property {module:ol/format/GMLBase~GMLBase} [gmlFormat] The GML format to use to parse the response. Default is `ol.format.GML3`. + * @property {string} [schemaLocation] Optional schemaLocation to use for serialization, this will override the default. */ @@ -35,22 +31,22 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender, * @property {string} featureNS The namespace URI used for features. * @property {string} featurePrefix The prefix for the feature namespace. * @property {Array.} featureTypes The feature type names. - * @property {string|undefined} srsName SRS name. No srsName attribute will be set on + * @property {string} [srsName] SRS name. No srsName attribute will be set on * geometries when this is not provided. - * @property {string|undefined} handle Handle. - * @property {string|undefined} outputFormat Output format. - * @property {number|undefined} maxFeatures Maximum number of features to fetch. - * @property {string|undefined} geometryName Geometry name to use in a BBOX filter. - * @property {Array.|undefined} propertyNames Optional list of property names to serialize. - * @property {number|undefined} startIndex Start index to use for WFS paging. This is a + * @property {string} [handle] Handle. + * @property {string} [outputFormat] Output format. + * @property {number} [maxFeatures] Maximum number of features to fetch. + * @property {string} [geometryName] Geometry name to use in a BBOX filter. + * @property {Array.} [propertyNames] Optional list of property names to serialize. + * @property {number} [startIndex] Start index to use for WFS paging. This is a * WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. - * @property {number|undefined} count Number of features to retrieve when paging. This is a + * @property {number} [count] Number of features to retrieve when paging. This is a * WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some * Web Feature Services have repurposed `maxfeatures` instead. * @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter. - * @property {ol.format.filter.Filter|undefined} filter Filter condition. See + * @property {ol.format.filter.Filter} [filter] Filter condition. See * {@link ol.format.filter} for more information. - * @property {string|undefined} resultType Indicates what response should be returned, + * @property {string} [resultType] Indicates what response should be returned, * E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features. */ @@ -60,16 +56,14 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender, * @property {string} featureNS The namespace URI used for features. * @property {string} featurePrefix The prefix for the feature namespace. * @property {string} featureType The feature type name. - * @property {string|undefined} srsName SRS name. No srsName attribute will be set on + * @property {string} [srsName] SRS name. No srsName attribute will be set on * geometries when this is not provided. - * @property {string|undefined} handle Handle. - * @property {boolean|undefined} hasZ Must be set to true if the transaction is for + * @property {string} [handle] Handle. + * @property {boolean} [hasZ] Must be set to true if the transaction is for * a 3D layer. This will allow the Z coordinate to be included in the transaction. * @property {Array.} nativeElements Native elements. Currently not supported. - * @property {module:ol/format/GMLBase~Options|undefined} gmlOptions GML options for - * the WFS transaction writer. - * @property {string|undefined} version WFS version to use for the transaction. Can be - * either `1.0.0` or `1.1.0`. Default is `1.1.0`. + * @property {module:ol/format/GMLBase~Options} [gmlOptions] GML options for the WFS transaction writer. + * @property {string} [version='1.1.0'] WFS version to use for the transaction. Can be either `1.0.0` or `1.1.0`. */ diff --git a/src/ol/format/WMSGetFeatureInfo.js b/src/ol/format/WMSGetFeatureInfo.js index 412a4d2f72..6f0b74f11c 100644 --- a/src/ol/format/WMSGetFeatureInfo.js +++ b/src/ol/format/WMSGetFeatureInfo.js @@ -11,8 +11,7 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js'; /** * @typedef {Object} Options - * @property {Array.|undefined} layers If set, only features of the - * given layers will be returned by the format when read. + * @property {Array.} [layers] If set, only features of the given layers will be returned by the format when read. */