ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2629 from elemoine/apistable-format

Browse Source 
Add @api stable annotations to ol.format
This commit is contained in:
Éric Lemoine
2014-08-28 17:37:06 +02:00
parent 00bf5462ba f8b9896dd3
commit 41ee554969
11 changed files with 85 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/ol/format/featureformat.js
View File

@@ -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() {

16
src/ol/format/geojsonformat.js
View File

@@ -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.<ol.Feature>} 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.<ol.Feature>} 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;

6
src/ol/format/gmlformat.js
View File

@@ -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.<ol.Feature>} Features.
* @api
* @api stable
*/
ol.format.GML.prototype.readFeatures;
@@ -1725,7 +1725,7 @@ ol.format.GML.prototype.writeGeometryNode = function(geometry, opt_options) {
* @param {Array.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Result.
* @api
* @api stable
*/
ol.format.GML.prototype.writeFeatures;

10
src/ol/format/gpxformat.js
View File

@@ -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.<ol.Feature>} 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.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Write options.
* @return {Node} Result.
* @api
* @api stable
*/
ol.format.GPX.prototype.writeFeatures;

12
src/ol/format/kmlformat.js
View File

@@ -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.<ol.Feature>} 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.<ol.Feature>} features Features.
* @param {olx.format.WriteOptions=} opt_options Options.
* @return {Node} Result.
* @api
* @api stable
*/
ol.format.KML.prototype.writeFeatures;

6
src/ol/format/osmxmlformat.js
View File

@@ -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.<ol.Feature>} 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;

12
src/ol/format/polylineformat.js
View File

@@ -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.<ol.Feature>} 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;

6
src/ol/format/topojsonformat.js
View File

@@ -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.<ol.Feature>} 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;

18
src/ol/format/wfsformat.js
View File

@@ -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.<string>}}
* @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.<ol.Feature>} 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.<ol.Feature>} 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;

14
src/ol/format/wktformat.js
View File

@@ -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.<ol.Feature>} 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.<ol.Feature>} 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;