Move jsdoc constructor comments
This commit is contained in:
@@ -58,12 +58,14 @@ GEOMETRY_WRITERS[GeometryType.MULTI_POLYGON] = writeMultiPolygonGeometry;
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for reading and writing data in the EsriJSON format.
|
* Feature format for reading and writing data in the EsriJSON format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/JSONFeature}
|
* @extends {module:ol/format/JSONFeature}
|
||||||
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class EsriJSON {
|
class EsriJSON {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -56,7 +56,6 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
|
|||||||
* {@link module:ol/Feature~Feature} objects from a variety of commonly used geospatial
|
* {@link module:ol/Feature~Feature} objects from a variety of commonly used geospatial
|
||||||
* file formats. See the documentation for each format for more details.
|
* file formats. See the documentation for each format for more details.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -37,12 +37,14 @@ const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
|
|||||||
* Feature format for reading and writing data in the GML format,
|
* Feature format for reading and writing data in the GML format,
|
||||||
* version 2.1.2.
|
* version 2.1.2.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
|
|
||||||
* @extends {module:ol/format/GMLBase}
|
* @extends {module:ol/format/GMLBase}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class GML2 {
|
class GML2 {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
const options = /** @type {module:ol/format/GMLBase~Options} */
|
const options = /** @type {module:ol/format/GMLBase~Options} */
|
||||||
(opt_options ? opt_options : {});
|
(opt_options ? opt_options : {});
|
||||||
|
|||||||
@@ -48,13 +48,14 @@ const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
|
|||||||
* version 3.1.1.
|
* version 3.1.1.
|
||||||
* Currently only supports GML 3.1.1 Simple Features profile.
|
* Currently only supports GML 3.1.1 Simple Features profile.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @param {module:ol/format/GMLBase~Options=} opt_options
|
|
||||||
* Optional configuration object.
|
|
||||||
* @extends {module:ol/format/GMLBase}
|
* @extends {module:ol/format/GMLBase}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class GML3 {
|
class GML3 {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
const options = /** @type {module:ol/format/GMLBase~Options} */
|
const options = /** @type {module:ol/format/GMLBase~Options} */
|
||||||
(opt_options ? opt_options : {});
|
(opt_options ? opt_options : {});
|
||||||
|
|||||||
@@ -83,13 +83,14 @@ const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
|
|||||||
* This class cannot be instantiated, it contains only base content that
|
* This class cannot be instantiated, it contains only base content that
|
||||||
* is shared with versioned format classes GML2 and GML3.
|
* is shared with versioned format classes GML2 and GML3.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @param {module:ol/format/GMLBase~Options=} opt_options
|
|
||||||
* Optional configuration object.
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
*/
|
*/
|
||||||
class GMLBase {
|
class GMLBase {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/GMLBase~Options=} opt_options Optional configuration object.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
const options = /** @type {module:ol/format/GMLBase~Options} */ (opt_options ? opt_options : {});
|
const options = /** @type {module:ol/format/GMLBase~Options} */ (opt_options ? opt_options : {});
|
||||||
|
|
||||||
|
|||||||
@@ -103,12 +103,14 @@ const GPX_SERIALIZERS = makeStructureNS(
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for reading and writing data in the GPX format.
|
* Feature format for reading and writing data in the GPX format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
* @param {module:ol/format/GPX~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class GPX {
|
class GPX {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/GPX~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -37,12 +37,14 @@ import {get as getProjection} from '../proj.js';
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for reading and writing data in the GeoJSON format.
|
* Feature format for reading and writing data in the GeoJSON format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/JSONFeature}
|
* @extends {module:ol/format/JSONFeature}
|
||||||
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class GeoJSON {
|
class GeoJSON {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -61,12 +61,14 @@ const NEWLINE_RE = /\r\n|\r|\n/;
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for `*.igc` flight recording files.
|
* Feature format for `*.igc` flight recording files.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/TextFeature}
|
* @extends {module:ol/format/TextFeature}
|
||||||
* @param {module:ol/format/IGC~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class IGC {
|
class IGC {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/IGC~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ import FormatType from '../format/FormatType.js';
|
|||||||
* instantiated in apps.
|
* instantiated in apps.
|
||||||
* Base class for JSON feature formats.
|
* Base class for JSON feature formats.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @extends {module:ol/format/Feature}
|
* @extends {module:ol/format/Feature}
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -391,12 +391,14 @@ function createStyleDefaults() {
|
|||||||
* Note that the KML format uses the URL() constructor. Older browsers such as IE
|
* Note that the KML format uses the URL() constructor. Older browsers such as IE
|
||||||
* which do not support this will need a URL polyfill to be loaded before use.
|
* which do not support this will need a URL polyfill to be loaded before use.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
* @param {module:ol/format/KML~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class KML {
|
class KML {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/KML~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -42,12 +42,15 @@ import RenderFeature from '../render/Feature.js';
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for reading data in the Mapbox MVT format.
|
* Feature format for reading data in the Mapbox MVT format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/Feature}
|
* @extends {module:ol/format/Feature}
|
||||||
* @param {module:ol/format/MVT~Options=} opt_options Options.
|
* @param {module:ol/format/MVT~Options=} opt_options Options.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class MVT {
|
class MVT {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/MVT~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
FeatureFormat.call(this);
|
FeatureFormat.call(this);
|
||||||
|
|||||||
@@ -50,7 +50,6 @@ const PARSERS = makeStructureNS(
|
|||||||
* Feature format for reading data in the
|
* Feature format for reading data in the
|
||||||
* [OSMXML format](http://wiki.openstreetmap.org/wiki/OSM_XML).
|
* [OSMXML format](http://wiki.openstreetmap.org/wiki/OSM_XML).
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -28,7 +28,6 @@ const PARSERS = makeStructureNS(
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XML}
|
* @extends {module:ol/format/XML}
|
||||||
*/
|
*/
|
||||||
class OWS {
|
class OWS {
|
||||||
|
|||||||
@@ -27,12 +27,14 @@ import {get as getProjection} from '../proj.js';
|
|||||||
* Feature format for reading and writing data in the Encoded
|
* Feature format for reading and writing data in the Encoded
|
||||||
* Polyline Algorithm Format.
|
* Polyline Algorithm Format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/TextFeature}
|
* @extends {module:ol/format/TextFeature}
|
||||||
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class Polyline {
|
class Polyline {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ import FormatType from '../format/FormatType.js';
|
|||||||
* instantiated in apps.
|
* instantiated in apps.
|
||||||
* Base class for text feature formats.
|
* Base class for text feature formats.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @extends {module:ol/format/Feature}
|
* @extends {module:ol/format/Feature}
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -43,12 +43,14 @@ import {get as getProjection} from '../proj.js';
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Feature format for reading data in the TopoJSON format.
|
* Feature format for reading data in the TopoJSON format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/JSONFeature}
|
* @extends {module:ol/format/JSONFeature}
|
||||||
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class TopoJSON {
|
class TopoJSON {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -201,12 +201,14 @@ const DEFAULT_VERSION = '1.1.0';
|
|||||||
* as option if you want to read a WFS that contains GML2 (WFS 1.0.0).
|
* as option if you want to read a WFS that contains GML2 (WFS 1.0.0).
|
||||||
* Also see {@link module:ol/format/GMLBase~GMLBase} which is used by this format.
|
* Also see {@link module:ol/format/GMLBase~GMLBase} which is used by this format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @param {module:ol/format/WFS~Options=} opt_options Optional configuration object.
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class WFS {
|
class WFS {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/WFS~Options=} opt_options Optional configuration object.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|
||||||
|
|||||||
+12
-6
@@ -87,10 +87,12 @@ const TokenType = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Class to tokenize a WKT string.
|
* Class to tokenize a WKT string.
|
||||||
* @param {string} wkt WKT string.
|
|
||||||
* @constructor
|
|
||||||
*/
|
*/
|
||||||
class Lexer {
|
class Lexer {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} wkt WKT string.
|
||||||
|
*/
|
||||||
constructor(wkt) {
|
constructor(wkt) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -218,10 +220,12 @@ class Lexer {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Class to parse the tokens from the WKT string.
|
* Class to parse the tokens from the WKT string.
|
||||||
* @param {module:ol/format/WKT~Lexer} lexer The lexer.
|
|
||||||
* @constructor
|
|
||||||
*/
|
*/
|
||||||
class Parser {
|
class Parser {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/WKT~Lexer} lexer The lexer.
|
||||||
|
*/
|
||||||
constructor(lexer) {
|
constructor(lexer) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -590,12 +594,14 @@ class Parser {
|
|||||||
* Geometry format for reading and writing data in the `WellKnownText` (WKT)
|
* Geometry format for reading and writing data in the `WellKnownText` (WKT)
|
||||||
* format.
|
* format.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/TextFeature}
|
* @extends {module:ol/format/TextFeature}
|
||||||
* @param {module:ol/format/WKT~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class WKT {
|
class WKT {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/WKT~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -46,7 +46,6 @@ const CAPABILITY_PARSERS = makeStructureNS(
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Format for reading WMS capabilities data
|
* Format for reading WMS capabilities data
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XML}
|
* @extends {module:ol/format/XML}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -34,12 +34,14 @@ const layerIdentifier = '_layer';
|
|||||||
* Format for reading WMSGetFeatureInfo format. It uses
|
* Format for reading WMSGetFeatureInfo format. It uses
|
||||||
* {@link module:ol/format/GML2~GML2} to read features.
|
* {@link module:ol/format/GML2~GML2} to read features.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XMLFeature}
|
* @extends {module:ol/format/XMLFeature}
|
||||||
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class WMSGetFeatureInfo {
|
class WMSGetFeatureInfo {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
|
||||||
|
*/
|
||||||
constructor(opt_options) {
|
constructor(opt_options) {
|
||||||
|
|
||||||
const options = opt_options ? opt_options : {};
|
const options = opt_options ? opt_options : {};
|
||||||
|
|||||||
@@ -45,7 +45,6 @@ const PARSERS = makeStructureNS(
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Format for reading WMTS capabilities data.
|
* Format for reading WMTS capabilities data.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @extends {module:ol/format/XML}
|
* @extends {module:ol/format/XML}
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -7,9 +7,7 @@ import {isDocument, isNode, parse} from '../xml.js';
|
|||||||
* @classdesc
|
* @classdesc
|
||||||
* Generic format for reading non-feature XML data
|
* Generic format for reading non-feature XML data
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @struct
|
|
||||||
*/
|
*/
|
||||||
class XML {
|
class XML {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ import {isDocument, isNode, parse} from '../xml.js';
|
|||||||
* instantiated in apps.
|
* instantiated in apps.
|
||||||
* Base class for XML feature formats.
|
* Base class for XML feature formats.
|
||||||
*
|
*
|
||||||
* @constructor
|
|
||||||
* @abstract
|
* @abstract
|
||||||
* @extends {module:ol/format/Feature}
|
* @extends {module:ol/format/Feature}
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user