Merge pull request #2408 from gingerik/wkt-apidoc
Fix apidoc for WKT format.
This commit is contained in:
+2
-1
@@ -1425,7 +1425,8 @@ olx.format.WKTOptions;
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether to split GEOMETRYCOLLECTION's into multiple features.
|
* Whether to split GeometryCollections into
|
||||||
|
* multiple features on reading. Default is `false`.
|
||||||
* @type {boolean|undefined}
|
* @type {boolean|undefined}
|
||||||
*/
|
*/
|
||||||
olx.format.WKTOptions.prototype.splitCollection;
|
olx.format.WKTOptions.prototype.splitCollection;
|
||||||
|
|||||||
@@ -206,6 +206,7 @@ ol.format.WKT.prototype.parse_ = function(wkt) {
|
|||||||
/**
|
/**
|
||||||
* Read a feature from a WKT source.
|
* Read a feature from a WKT source.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
||||||
* @return {ol.Feature} Feature.
|
* @return {ol.Feature} Feature.
|
||||||
* @api
|
* @api
|
||||||
@@ -230,6 +231,7 @@ ol.format.WKT.prototype.readFeatureFromText = function(text) {
|
|||||||
/**
|
/**
|
||||||
* Read all features from a WKT source.
|
* Read all features from a WKT source.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
||||||
* @return {Array.<ol.Feature>} Features.
|
* @return {Array.<ol.Feature>} Features.
|
||||||
* @api
|
* @api
|
||||||
@@ -263,6 +265,7 @@ ol.format.WKT.prototype.readFeaturesFromText = function(text) {
|
|||||||
/**
|
/**
|
||||||
* Read a single geometry from a WKT source.
|
* Read a single geometry from a WKT source.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
|
||||||
* @return {ol.geom.Geometry} Geometry.
|
* @return {ol.geom.Geometry} Geometry.
|
||||||
* @api
|
* @api
|
||||||
@@ -289,6 +292,7 @@ ol.format.WKT.prototype.readProjectionFromText = function(text) {
|
|||||||
/**
|
/**
|
||||||
* Encode a feature as a WKT string.
|
* Encode a feature as a WKT string.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {ol.Feature} feature Feature.
|
* @param {ol.Feature} feature Feature.
|
||||||
* @return {ArrayBuffer|Node|Object|string} Result.
|
* @return {ArrayBuffer|Node|Object|string} Result.
|
||||||
* @api
|
* @api
|
||||||
@@ -311,6 +315,7 @@ ol.format.WKT.prototype.writeFeatureText = function(feature) {
|
|||||||
/**
|
/**
|
||||||
* Encode an array of features as a WKT string.
|
* Encode an array of features as a WKT string.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {Array.<ol.Feature>} features Features.
|
* @param {Array.<ol.Feature>} features Features.
|
||||||
* @return {ArrayBuffer|Node|Object|string} Result.
|
* @return {ArrayBuffer|Node|Object|string} Result.
|
||||||
* @api
|
* @api
|
||||||
@@ -337,6 +342,7 @@ ol.format.WKT.prototype.writeFeaturesText = function(features) {
|
|||||||
/**
|
/**
|
||||||
* Write a single geometry as a WKT string.
|
* Write a single geometry as a WKT string.
|
||||||
*
|
*
|
||||||
|
* @function
|
||||||
* @param {ol.geom.Geometry} geometry Geometry.
|
* @param {ol.geom.Geometry} geometry Geometry.
|
||||||
* @return {ArrayBuffer|Node|Object|string} Node.
|
* @return {ArrayBuffer|Node|Object|string} Node.
|
||||||
* @api
|
* @api
|
||||||
|
|||||||
Reference in New Issue
Block a user