From 26df575bfec6d8505df17c300bcd24b21b1e3e98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:36:27 +0200 Subject: [PATCH 01/12] Add @api stable annotations for GeoJSON format --- externs/olx.js | 4 ++-- src/ol/format/geojsonformat.js | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index b7ae6e73ea..de8a6bce6c 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1347,7 +1347,7 @@ olx.format.GeoJSONOptions; /** * Default data projection. * @type {ol.proj.ProjectionLike} - * @api + * @api stable */ olx.format.GeoJSONOptions.prototype.defaultDataProjection; @@ -1355,7 +1355,7 @@ olx.format.GeoJSONOptions.prototype.defaultDataProjection; /** * Geometry name to use when creating features. * @type {string|undefined} - * @api + * @api stable */ olx.format.GeoJSONOptions.prototype.geometryName; diff --git a/src/ol/format/geojsonformat.js b/src/ol/format/geojsonformat.js index 1897772a5b..098cb7fffd 100644 --- a/src/ol/format/geojsonformat.js +++ b/src/ol/format/geojsonformat.js @@ -28,7 +28,7 @@ goog.require('ol.proj'); * @constructor * @extends {ol.format.JSONFeature} * @param {olx.format.GeoJSONOptions=} opt_options Options. - * @api + * @api stable */ ol.format.GeoJSON = function(opt_options) { @@ -350,7 +350,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.Feature} Feature. - * @api + * @api stable */ ol.format.GeoJSON.prototype.readFeature; @@ -363,7 +363,7 @@ ol.format.GeoJSON.prototype.readFeature; * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.GeoJSON.prototype.readFeatures; @@ -426,7 +426,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function( * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.geom.Geometry} Geometry. - * @api + * @api stable */ ol.format.GeoJSON.prototype.readGeometry; @@ -447,7 +447,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function( * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.GeoJSON.prototype.readProjection; @@ -484,7 +484,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) { * @param {ol.Feature} feature Feature. * @param {olx.format.WriteOptions} options Write options. * @return {GeoJSONFeature} GeoJSON. - * @api + * @api stable */ ol.format.GeoJSON.prototype.writeFeature; @@ -523,7 +523,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function( * @param {Array.} features Features. * @param {olx.format.WriteOptions} options Write options. * @return {GeoJSONObject} GeoJSON. - * @api + * @api stable */ ol.format.GeoJSON.prototype.writeFeatures; @@ -552,7 +552,7 @@ ol.format.GeoJSON.prototype.writeFeaturesObject = * @param {ol.geom.Geometry} geometry Geometry. * @param {olx.format.WriteOptions} options Write options. * @return {GeoJSONGeometry|GeoJSONGeometryCollection} GeoJSON. - * @api + * @api stable */ ol.format.GeoJSON.prototype.writeGeometry; From 1f9ab586232ea6a66046669ca6efaab433695f9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:38:14 +0200 Subject: [PATCH 02/12] Add @api stable annotations for GML format --- externs/olx.js | 14 +++++++------- src/ol/format/gmlformat.js | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index de8a6bce6c..4c3c2d8d38 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1448,7 +1448,7 @@ olx.format.GMLOptions; /** * Feature namespace. * @type {string} - * @api + * @api stable */ olx.format.GMLOptions.prototype.featureNS; @@ -1456,7 +1456,7 @@ olx.format.GMLOptions.prototype.featureNS; /** * Feature type to parse. * @type {string} - * @api + * @api stable */ olx.format.GMLOptions.prototype.featureType; @@ -1473,7 +1473,7 @@ olx.format.GMLOptions.prototype.srsName; * Write gml:Surface instead of gml:Polygon elements. This also affects the * elements in multi-part geometries. Default is `false`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.GMLOptions.prototype.surface; @@ -1482,7 +1482,7 @@ olx.format.GMLOptions.prototype.surface; * Write gml:Curve instead of gml:LineString elements. This also affects the * elements in multi-part geometries. Default is `false`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.GMLOptions.prototype.curve; @@ -1491,7 +1491,7 @@ olx.format.GMLOptions.prototype.curve; * Write gml:MultiCurve instead of gml:MultiLineString. Since the latter is * deprecated in GML 3, the default is `true`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.GMLOptions.prototype.multiCurve; @@ -1500,7 +1500,7 @@ olx.format.GMLOptions.prototype.multiCurve; * Write gml:multiSurface instead of gml:MultiPolygon. Since the latter is * deprecated in GML 3, the default is `true`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.GMLOptions.prototype.multiSurface; @@ -1509,7 +1509,7 @@ olx.format.GMLOptions.prototype.multiSurface; * Optional schemaLocation to use when writing out the GML, this will override * the default provided. * @type {string|undefined} - * @api + * @api stable */ olx.format.GMLOptions.prototype.schemaLocation; diff --git a/src/ol/format/gmlformat.js b/src/ol/format/gmlformat.js index dd174edd7f..d235fc3ac5 100644 --- a/src/ol/format/gmlformat.js +++ b/src/ol/format/gmlformat.js @@ -36,7 +36,7 @@ goog.require('ol.xml'); * @param {olx.format.GMLOptions=} opt_options * Optional configuration object. * @extends {ol.format.XMLFeature} - * @api + * @api stable */ ol.format.GML = function(opt_options) { var options = /** @type {olx.format.GMLOptions} */ @@ -1056,7 +1056,7 @@ ol.format.GML.prototype.readGeometryFromNode = function(node, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.GML.prototype.readFeatures; @@ -1725,7 +1725,7 @@ ol.format.GML.prototype.writeGeometryNode = function(geometry, opt_options) { * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Result. - * @api + * @api stable */ ol.format.GML.prototype.writeFeatures; From 51202481882f7b9d553e7247f39b8f9b2cbfdc0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:39:25 +0200 Subject: [PATCH 03/12] Add @api stable annotations for GPX format --- externs/olx.js | 2 +- src/ol/format/gpxformat.js | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 4c3c2d8d38..c7888f6061 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1529,7 +1529,7 @@ olx.format.GPXOptions; * nodes from `wpt`, `rte` and `trk` can be processed, as those are * directly mapped to a feature. * @type {function(ol.Feature, Node)} - * @api + * @api stable */ olx.format.GPXOptions.prototype.readExtensions; diff --git a/src/ol/format/gpxformat.js b/src/ol/format/gpxformat.js index 3fcae43c0a..23492bbccd 100644 --- a/src/ol/format/gpxformat.js +++ b/src/ol/format/gpxformat.js @@ -23,7 +23,7 @@ goog.require('ol.xml'); * @constructor * @extends {ol.format.XMLFeature} * @param {olx.format.GPXOptions=} opt_options Options. - * @api + * @api stable */ ol.format.GPX = function(opt_options) { @@ -429,7 +429,7 @@ ol.format.GPX.prototype.handleReadExtensions_ = function(features) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.Feature} Feature. - * @api + * @api stable */ ol.format.GPX.prototype.readFeature; @@ -462,7 +462,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.GPX.prototype.readFeatures; @@ -496,7 +496,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node, opt_options) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.GPX.prototype.readProjection; @@ -870,7 +870,7 @@ ol.format.GPX.GPX_SERIALIZERS_ = ol.xml.makeStructureNS( * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {Node} Result. - * @api + * @api stable */ ol.format.GPX.prototype.writeFeatures; From e0c173bd24a5eda37b626edac64980a3fbfa6734 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:42:47 +0200 Subject: [PATCH 04/12] Add @api stable annotations for KML format --- externs/olx.js | 4 ++-- src/ol/format/kmlformat.js | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index c7888f6061..92865f3db0 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1418,7 +1418,7 @@ olx.format.KMLOptions; /** * Extract styles from the KML. Default is `true`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.KMLOptions.prototype.extractStyles; @@ -1426,7 +1426,7 @@ olx.format.KMLOptions.prototype.extractStyles; /** * Default style. The default default style is the same as Google Earth. * @type {Array.|undefined} - * @api + * @api stable */ olx.format.KMLOptions.prototype.defaultStyle; diff --git a/src/ol/format/kmlformat.js b/src/ol/format/kmlformat.js index 57c7625997..656b946c9c 100644 --- a/src/ol/format/kmlformat.js +++ b/src/ol/format/kmlformat.js @@ -64,7 +64,7 @@ ol.format.KMLGxTrackObject_; * @constructor * @extends {ol.format.XMLFeature} * @param {olx.format.KMLOptions=} opt_options Options. - * @api + * @api stable */ ol.format.KML = function(opt_options) { @@ -1509,7 +1509,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.Feature} Feature. - * @api + * @api stable */ ol.format.KML.prototype.readFeature; @@ -1540,7 +1540,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.KML.prototype.readFeatures; @@ -1591,7 +1591,7 @@ ol.format.KML.prototype.readFeaturesFromNode = function(node, opt_options) { /** * @param {Document|Node|string} source Souce. * @return {string|undefined} Name. - * @api + * @api stable */ ol.format.KML.prototype.readName = function(source) { if (ol.xml.isDocument(source)) { @@ -1661,7 +1661,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.KML.prototype.readProjection; @@ -2526,7 +2526,7 @@ ol.format.KML.OUTER_BOUNDARY_NODE_FACTORY_ = * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Options. * @return {Node} Result. - * @api + * @api stable */ ol.format.KML.prototype.writeFeatures; From a09b5d61aedfa691a4a0e284c0e367d6b185c96c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:43:40 +0200 Subject: [PATCH 05/12] Add @api stable annotations for OSMXML format --- src/ol/format/osmxmlformat.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/ol/format/osmxmlformat.js b/src/ol/format/osmxmlformat.js index fb23b224a2..ebc332de4f 100644 --- a/src/ol/format/osmxmlformat.js +++ b/src/ol/format/osmxmlformat.js @@ -23,7 +23,7 @@ goog.require('ol.xml'); * * @constructor * @extends {ol.format.XMLFeature} - * @api + * @api stable */ ol.format.OSMXML = function() { goog.base(this); @@ -201,7 +201,7 @@ ol.format.OSMXML.NODE_PARSERS_ = ol.xml.makeParsersNS( * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.OSMXML.prototype.readFeatures; @@ -231,7 +231,7 @@ ol.format.OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.OSMXML.prototype.readProjection; From ceb0cc54cef39c73e24585b05b6d8cd3a9b5ec50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:45:10 +0200 Subject: [PATCH 06/12] Add @api stable annotations for Polyline format --- externs/olx.js | 2 +- src/ol/format/polylineformat.js | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 92865f3db0..e12b8145cb 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1371,7 +1371,7 @@ olx.format.PolylineOptions; * The factor by which the coordinates values will be scaled. * Default is `1e5`. * @type {number} - * @api + * @api stable */ olx.format.PolylineOptions.prototype.factor; diff --git a/src/ol/format/polylineformat.js b/src/ol/format/polylineformat.js index 56fbe5e2b9..07f61873cf 100644 --- a/src/ol/format/polylineformat.js +++ b/src/ol/format/polylineformat.js @@ -15,7 +15,7 @@ goog.require('ol.proj'); * @extends {ol.format.TextFeature} * @param {olx.format.PolylineOptions=} opt_options * Optional configuration object. - * @api + * @api stable */ ol.format.Polyline = function(opt_options) { @@ -256,7 +256,7 @@ ol.format.Polyline.encodeUnsignedInteger = function(num) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.Feature} Feature. - * @api + * @api stable */ ol.format.Polyline.prototype.readFeature; @@ -278,7 +278,7 @@ ol.format.Polyline.prototype.readFeatureFromText = function(text, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.Polyline.prototype.readFeatures; @@ -300,7 +300,7 @@ ol.format.Polyline.prototype.readFeaturesFromText = * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.geom.Geometry} Geometry. - * @api + * @api stable */ ol.format.Polyline.prototype.readGeometry; @@ -327,7 +327,7 @@ ol.format.Polyline.prototype.readGeometryFromText = * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.Polyline.prototype.readProjection; @@ -371,7 +371,7 @@ ol.format.Polyline.prototype.writeFeaturesText = * @param {ol.geom.Geometry} geometry Geometry. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {string} Geometry. - * @api + * @api stable */ ol.format.Polyline.prototype.writeGeometry; From de4131f207f9eed631eb664da392bb328fbf04e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:46:05 +0200 Subject: [PATCH 07/12] Add @api stable annotations for TopoJSON format --- externs/olx.js | 2 +- src/ol/format/topojsonformat.js | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index e12b8145cb..e70749c4fc 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1386,7 +1386,7 @@ olx.format.TopoJSONOptions; /** * Default data projection. * @type {ol.proj.ProjectionLike} - * @api + * @api stable */ olx.format.TopoJSONOptions.prototype.defaultDataProjection; diff --git a/src/ol/format/topojsonformat.js b/src/ol/format/topojsonformat.js index afe0d4aa8b..2773f2e621 100644 --- a/src/ol/format/topojsonformat.js +++ b/src/ol/format/topojsonformat.js @@ -22,7 +22,7 @@ goog.require('ol.proj'); * @constructor * @extends {ol.format.JSONFeature} * @param {olx.format.TopoJSONOptions=} opt_options Options. - * @api + * @api stable */ ol.format.TopoJSON = function(opt_options) { @@ -276,7 +276,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs, * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. - * @api + * @api stable */ ol.format.TopoJSON.prototype.readFeatures; @@ -387,7 +387,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) { * @function * @param {ArrayBuffer|Document|Node|Object|string} object Source. * @return {ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.TopoJSON.prototype.readProjection = function(object) { return this.defaultDataProjection; From 5eced4a015a63420c42270aeb716d301be680822 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:49:10 +0200 Subject: [PATCH 08/12] Add @api stable annotations for WFS format --- externs/olx.js | 30 +++++++++++++++--------------- src/ol/format/wfsformat.js | 18 +++++++++--------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index e70749c4fc..1109de25fe 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1546,7 +1546,7 @@ olx.format.WFSOptions; /** * The namespace URI used for features. * @type {string} - * @api + * @api stable */ olx.format.WFSOptions.prototype.featureNS; @@ -1554,7 +1554,7 @@ olx.format.WFSOptions.prototype.featureNS; /** * The feature type to parse. Only used for read operations. * @type {string} - * @api + * @api stable */ olx.format.WFSOptions.prototype.featureType; @@ -1563,7 +1563,7 @@ olx.format.WFSOptions.prototype.featureType; * Optional schemaLocation to use for serialization, this will override the * default. * @type {string|undefined} - * @api + * @api stable */ olx.format.WFSOptions.prototype.schemaLocation; @@ -1586,7 +1586,7 @@ olx.format.WFSWriteGetFeatureOptions; /** * The namespace URI used for features. * @type {string} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.featureNS; @@ -1594,7 +1594,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.featureNS; /** * The prefix for the feature namespace. * @type {string} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.featurePrefix; @@ -1602,7 +1602,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.featurePrefix; /** * The feature type names. * @type {Array.} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.featureTypes; @@ -1619,7 +1619,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.srsName; /** * Handle. * @type {string|undefined} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.handle; @@ -1627,7 +1627,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.handle; /** * Output format. * @type {string|undefined} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.outputFormat; @@ -1635,7 +1635,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.outputFormat; /** * Maximum number of features to fetch. * @type {number|undefined} - * @api + * @api stable */ olx.format.WFSWriteGetFeatureOptions.prototype.maxFeatures; @@ -1664,7 +1664,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.bbox; * handle: (string|undefined), * nativeElements: Array., * gmlOptions: (olx.format.GMLOptions|undefined)}} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions; @@ -1672,7 +1672,7 @@ olx.format.WFSWriteTransactionOptions; /** * The namespace URI used for features. * @type {string} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions.prototype.featureNS; @@ -1680,7 +1680,7 @@ olx.format.WFSWriteTransactionOptions.prototype.featureNS; /** * The prefix for the feature namespace. * @type {string} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions.prototype.featurePrefix; @@ -1688,7 +1688,7 @@ olx.format.WFSWriteTransactionOptions.prototype.featurePrefix; /** * The feature type name. * @type {string} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions.prototype.featureType; @@ -1705,7 +1705,7 @@ olx.format.WFSWriteTransactionOptions.prototype.srsName; /** * Handle. * @type {string|undefined} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions.prototype.handle; @@ -1721,7 +1721,7 @@ olx.format.WFSWriteTransactionOptions.prototype.nativeElements; /** * GML options for the WFS transaction writer. * @type {olx.format.GMLOptions|undefined} - * @api + * @api stable */ olx.format.WFSWriteTransactionOptions.prototype.gmlOptions; diff --git a/src/ol/format/wfsformat.js b/src/ol/format/wfsformat.js index 97e9e222fe..8e0d7f0468 100644 --- a/src/ol/format/wfsformat.js +++ b/src/ol/format/wfsformat.js @@ -22,7 +22,7 @@ goog.require('ol.xml'); * @param {olx.format.WFSOptions=} opt_options * Optional configuration object. * @extends {ol.format.XMLFeature} - * @api + * @api stable */ ol.format.WFS = function(opt_options) { var options = /** @type {olx.format.WFSOptions} */ @@ -70,7 +70,7 @@ ol.format.WFS.xmlns = 'http://www.w3.org/2000/xmlns/'; * Number of features; bounds/extent. * @typedef {{numberOfFeatures: number, * bounds: ol.Extent}} - * @api + * @api stable */ ol.format.WFS.FeatureCollectionMetadata; @@ -81,7 +81,7 @@ ol.format.WFS.FeatureCollectionMetadata; * totalInserted: number, * totalUpdated: number, * insertIds: Array.}} - * @api + * @api stable */ ol.format.WFS.TransactionResponse; @@ -102,7 +102,7 @@ ol.format.WFS.schemaLocation_ = 'http://www.opengis.net/wfs ' + * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.WFS.prototype.readFeatures; @@ -130,7 +130,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node, opt_options) { /** * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.format.WFS.TransactionResponse|undefined} Transaction response. - * @api + * @api stable */ ol.format.WFS.prototype.readTransactionResponse = function(source) { if (ol.xml.isDocument(source)) { @@ -152,7 +152,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.format.WFS.FeatureCollectionMetadata|undefined} * FeatureCollection metadata. - * @api + * @api stable */ ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) { if (ol.xml.isDocument(source)) { @@ -601,7 +601,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) { /** * @param {olx.format.WFSWriteGetFeatureOptions} options Options. * @return {Node} Result. - * @api + * @api stable */ ol.format.WFS.prototype.writeGetFeature = function(options) { var node = ol.xml.createElementNS('http://www.opengis.net/wfs', @@ -653,7 +653,7 @@ ol.format.WFS.prototype.writeGetFeature = function(options) { * @param {Array.} deletes The features to delete. * @param {olx.format.WFSWriteTransactionOptions} options Write options. * @return {Node} Result. - * @api + * @api stable */ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) { @@ -713,7 +713,7 @@ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes, * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {?ol.proj.Projection} Projection. - * @api + * @api stable */ ol.format.WFS.prototype.readProjection; From c8c59c365716802c247712840307104b4050cd98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:50:05 +0200 Subject: [PATCH 09/12] Add @api stable annotations for WKT format --- externs/olx.js | 2 +- src/ol/format/wktformat.js | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 1109de25fe..176034a77b 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1737,7 +1737,7 @@ olx.format.WKTOptions; * Whether to split GeometryCollections into * multiple features on reading. Default is `false`. * @type {boolean|undefined} - * @api + * @api stable */ olx.format.WKTOptions.prototype.splitCollection; diff --git a/src/ol/format/wktformat.js b/src/ol/format/wktformat.js index b90b683429..12e220ea9c 100644 --- a/src/ol/format/wktformat.js +++ b/src/ol/format/wktformat.js @@ -21,7 +21,7 @@ goog.require('ol.geom.Polygon'); * @constructor * @extends {ol.format.TextFeature} * @param {olx.format.WKTOptions=} opt_options Options. - * @api + * @api stable */ ol.format.WKT = function(opt_options) { @@ -211,7 +211,7 @@ ol.format.WKT.prototype.parse_ = function(wkt) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.Feature} Feature. - * @api + * @api stable */ ol.format.WKT.prototype.readFeature; @@ -237,7 +237,7 @@ ol.format.WKT.prototype.readFeatureFromText = function(text, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {Array.} Features. - * @api + * @api stable */ ol.format.WKT.prototype.readFeatures; @@ -272,7 +272,7 @@ ol.format.WKT.prototype.readFeaturesFromText = function(text, opt_options) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {olx.format.ReadOptions=} opt_options Read options. * @return {ol.geom.Geometry} Geometry. - * @api + * @api stable */ ol.format.WKT.prototype.readGeometry; @@ -306,7 +306,7 @@ ol.format.WKT.prototype.readProjectionFromText = function(text) { * @param {ol.Feature} feature Feature. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {string} WKT string. - * @api + * @api stable */ ol.format.WKT.prototype.writeFeature; @@ -330,7 +330,7 @@ ol.format.WKT.prototype.writeFeatureText = function(feature, opt_options) { * @param {Array.} features Features. * @param {olx.format.WriteOptions=} opt_options Write options. * @return {string} WKT string. - * @api + * @api stable */ ol.format.WKT.prototype.writeFeatures; @@ -357,7 +357,7 @@ ol.format.WKT.prototype.writeFeaturesText = function(features, opt_options) { * @function * @param {ol.geom.Geometry} geometry Geometry. * @return {string} WKT string. - * @api + * @api stable */ ol.format.WKT.prototype.writeGeometry; From 3338d567928d925c315899cc897b547e787d00be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:52:35 +0200 Subject: [PATCH 10/12] Add @api stable annotations to olx.format.ReadOptions --- externs/olx.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 176034a77b..97368314ba 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1294,7 +1294,7 @@ olx.format.ReadOptions; * the data and if no `defaultDataProjection` is set for a format, the features * will not be reprojected. * @type {ol.proj.ProjectionLike|undefined} - * @api + * @api stable */ olx.format.ReadOptions.prototype.dataProjection; @@ -1303,7 +1303,7 @@ olx.format.ReadOptions.prototype.dataProjection; * Projection of the feature geometries created by the format reader. If not * provided, features will be returned in the `dataProjection`. * @type {ol.proj.ProjectionLike|undefined} - * @api + * @api stable */ olx.format.ReadOptions.prototype.featureProjection; From 52c5897cccf4ea407dc7fcfcce4da5acf56fcbb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Tue, 26 Aug 2014 10:52:58 +0200 Subject: [PATCH 11/12] Add @api stable annotations to olx.format.WriteOptions --- externs/olx.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 97368314ba..b5dd20b244 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -1322,7 +1322,7 @@ olx.format.WriteOptions; * `defaultDataProjection` is set for a format, the features will be returned * in the `featureProjection`. * @type {ol.proj.ProjectionLike|undefined} - * @api + * @api stable */ olx.format.WriteOptions.prototype.dataProjection; @@ -1331,7 +1331,7 @@ olx.format.WriteOptions.prototype.dataProjection; * Projection of the feature geometries that will be serialized by the format * writer. * @type {ol.proj.ProjectionLike} - * @api + * @api stable */ olx.format.WriteOptions.prototype.featureProjection; From f8b9896dd39bcfed1da8899d7a32f3d9fb2785d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Wed, 27 Aug 2014 12:37:31 +0200 Subject: [PATCH 12/12] Add @api stable annotations to Feature format --- src/ol/format/featureformat.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/format/featureformat.js b/src/ol/format/featureformat.js index b5b5f20144..0f8bf20d1a 100644 --- a/src/ol/format/featureformat.js +++ b/src/ol/format/featureformat.js @@ -16,6 +16,7 @@ goog.require('ol.proj'); * file formats. See the documentation for each format for more details. * * @constructor + * @api stable */ ol.format.Feature = function() {