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] 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;