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

Use @api annotation instead of @todo api

Browse Source
This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,7 +27,7 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo api
* @api
*/
ol.format.GeoJSON = function(opt_options) {
@@ -331,7 +331,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.readFeature;
@@ -343,7 +343,7 @@ ol.format.GeoJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.readFeatures;
@@ -401,7 +401,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.readGeometry;
@@ -421,7 +421,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.readProjection;
@@ -457,7 +457,7 @@ ol.format.GeoJSON.prototype.readProjectionFromObject = function(object) {
* @function
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -493,7 +493,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.writeFeatures;
@@ -520,7 +520,7 @@ ol.format.GeoJSON.prototype.writeFeaturesObject = function(features) {
* @function
* @param {ol.geom.Geometry} geometry Geometry.
* @return {ArrayBuffer|Node|Object|string} GeoJSON.
* @todo api
* @api
*/
ol.format.GeoJSON.prototype.writeGeometry;

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

@@ -31,7 +31,7 @@ goog.require('ol.xml');
* @param {olx.format.GMLOptions=} opt_options
* Optional configuration object.
* @extends {ol.format.XMLFeature}
* @todo api
* @api
*/
ol.format.GML = function(opt_options) {
var options = /** @type {olx.format.GMLOptions} */
@@ -1048,7 +1048,7 @@ ol.format.GML.prototype.readGeometryFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.GML.prototype.readFeatures;
@@ -1690,7 +1690,7 @@ ol.format.GML.prototype.writeGeometryNode = function(geometry) {
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
* @api
*/
ol.format.GML.prototype.writeFeatures;

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

@@ -22,7 +22,7 @@ goog.require('ol.xml');
*
* @constructor
* @extends {ol.format.XMLFeature}
* @todo api
* @api
*/
ol.format.GPX = function() {
goog.base(this);
@@ -372,7 +372,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.GPX.prototype.readFeature;
@@ -403,7 +403,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.GPX.prototype.readFeatures;
@@ -436,7 +436,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.GPX.prototype.readProjection;
@@ -811,7 +811,7 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
* @api
*/
ol.format.GPX.prototype.writeFeatures;

8
src/ol/format/igcformat.js
View File

@@ -28,7 +28,7 @@ ol.format.IGCZ = {
* @constructor
* @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options.
* @todo api
* @api
*/
ol.format.IGC = function(opt_options) {
@@ -94,7 +94,7 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.IGC.prototype.readFeature;
@@ -180,7 +180,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.IGC.prototype.readFeatures;
@@ -204,7 +204,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.IGC.prototype.readProjection;

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

@@ -62,7 +62,7 @@ ol.format.KMLGxTrackObject_;
* @constructor
* @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options.
* @todo api
* @api
*/
ol.format.KML = function(opt_options) {
@@ -1488,7 +1488,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.KML.prototype.readFeature;
@@ -1517,7 +1517,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.KML.prototype.readFeatures;
@@ -1566,7 +1566,7 @@ ol.format.KML.prototype.readFeaturesFromNode = function(node) {
/**
* @param {Document|Node|string} source Souce.
* @return {string|undefined} Name.
* @todo api
* @api
*/
ol.format.KML.prototype.readName = function(source) {
if (ol.xml.isDocument(source)) {
@@ -1636,7 +1636,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.KML.prototype.readProjection;
@@ -2495,7 +2495,7 @@ ol.format.KML.OUTER_BOUNDARY_NODE_FACTORY_ =
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
* @api
*/
ol.format.KML.prototype.writeFeatures;

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

@@ -21,7 +21,7 @@ goog.require('ol.xml');
*
* @constructor
* @extends {ol.format.XMLFeature}
* @todo api
* @api
*/
ol.format.OSMXML = function() {
goog.base(this);
@@ -189,7 +189,7 @@ ol.format.OSMXML.NODE_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.OSMXML.prototype.readFeatures;
@@ -218,7 +218,7 @@ ol.format.OSMXML.prototype.readFeaturesFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.OSMXML.prototype.readProjection;

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

@@ -14,7 +14,7 @@ goog.require('ol.proj');
* @extends {ol.format.TextFeature}
* @param {olx.format.PolylineOptions=} opt_options
* Optional configuration object.
* @todo api
* @api
*/
ol.format.Polyline = function(opt_options) {
@@ -42,7 +42,7 @@ goog.inherits(ol.format.Polyline, ol.format.TextFeature);
* multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`.
* @return {string} The encoded string.
* @todo api
* @api
*/
ol.format.Polyline.encodeDeltas = function(numbers, stride, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -77,7 +77,7 @@ ol.format.Polyline.encodeDeltas = function(numbers, stride, opt_factor) {
* @param {number=} opt_factor The factor by which the resulting numbers will
* be divided. Default is `1e5`.
* @return {Array.<number>} A list of n-dimensional points.
* @todo api
* @api
*/
ol.format.Polyline.decodeDeltas = function(encoded, stride, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -114,7 +114,7 @@ ol.format.Polyline.decodeDeltas = function(encoded, stride, opt_factor) {
* multiplied. The remaining decimal places will get rounded away.
* Default is `1e5`.
* @return {string} The encoded string.
* @todo api
* @api
*/
ol.format.Polyline.encodeFloats = function(numbers, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -134,7 +134,7 @@ ol.format.Polyline.encodeFloats = function(numbers, opt_factor) {
* @param {number=} opt_factor The factor by which the result will be divided.
* Default is `1e5`.
* @return {Array.<number>} A list of floating point numbers.
* @todo api
* @api
*/
ol.format.Polyline.decodeFloats = function(encoded, opt_factor) {
var factor = goog.isDef(opt_factor) ? opt_factor : 1e5;
@@ -249,7 +249,7 @@ ol.format.Polyline.encodeUnsignedInteger = function(num) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.Polyline.prototype.readFeature;
@@ -270,7 +270,7 @@ ol.format.Polyline.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.Polyline.prototype.readFeatures;
@@ -290,7 +290,7 @@ ol.format.Polyline.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo api
* @api
*/
ol.format.Polyline.prototype.readGeometry;
@@ -312,7 +312,7 @@ ol.format.Polyline.prototype.readGeometryFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.Polyline.prototype.readProjection;
@@ -354,7 +354,7 @@ ol.format.Polyline.prototype.writeFeaturesText = function(features) {
* @function
* @param {ol.geom.Geometry} geometry Geometry.
* @return {string} Geometry.
* @todo api
* @api
*/
ol.format.Polyline.prototype.writeGeometry;

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

@@ -21,7 +21,7 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo api
* @api
*/
ol.format.TopoJSON = function(opt_options) {
@@ -273,7 +273,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.TopoJSON.prototype.readFeatures;
@@ -383,7 +383,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {
return this.defaultProjection_;

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

@@ -20,7 +20,7 @@ goog.require('ol.xml');
* @param {olx.format.WFSOptions=} opt_options
* Optional configuration object.
* @extends {ol.format.XMLFeature}
* @todo api
* @api
*/
ol.format.WFS = function(opt_options) {
var options = /** @type {olx.format.WFSOptions} */
@@ -95,7 +95,7 @@ ol.format.WFS.schemaLocation_ = 'http://www.opengis.net/wfs ' +
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.WFS.prototype.readFeatures;
@@ -120,7 +120,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) {
/**
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @todo api
* @api
*/
ol.format.WFS.prototype.readTransactionResponse = function(source) {
if (ol.xml.isDocument(source)) {
@@ -142,7 +142,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
* @todo api
* @api
*/
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
if (ol.xml.isDocument(source)) {
@@ -591,7 +591,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @todo api
* @api
*/
ol.format.WFS.prototype.writeGetFeature = function(options) {
var node = ol.xml.createElementNS('http://www.opengis.net/wfs',
@@ -643,7 +643,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.
* @todo api
* @api
*/
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
options) {
@@ -703,7 +703,7 @@ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {?ol.proj.Projection} Projection.
* @todo api
* @api
*/
ol.format.WFS.prototype.readProjection;

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

@@ -21,7 +21,7 @@ goog.require('ol.geom.Polygon');
* @extends {ol.format.TextFeature}
* @param {olx.format.WKTOptions=} opt_options Options.
* @todo stability experimental
* @todo api
* @api
*/
ol.format.WKT = function(opt_options) {
@@ -352,7 +352,7 @@ ol.format.WKT.prototype.encode_ = function(geom) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
* @api
*/
ol.format.WKT.prototype.readFeature;
@@ -376,7 +376,7 @@ ol.format.WKT.prototype.readFeatureFromText = function(text) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
* @api
*/
ol.format.WKT.prototype.readFeatures;
@@ -409,7 +409,7 @@ ol.format.WKT.prototype.readFeaturesFromText = function(text) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo api
* @api
*/
ol.format.WKT.prototype.readGeometry;
@@ -435,7 +435,7 @@ ol.format.WKT.prototype.readProjectionFromText = function(text) {
*
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
* @api
*/
ol.format.WKT.prototype.writeFeature;
@@ -457,7 +457,7 @@ ol.format.WKT.prototype.writeFeatureText = function(feature) {
*
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
* @api
*/
ol.format.WKT.prototype.writeFeatures;
@@ -483,7 +483,7 @@ ol.format.WKT.prototype.writeFeaturesText = function(features) {
*
* @param {ol.geom.Geometry} geometry Geometry.
* @return {ArrayBuffer|Node|Object|string} Node.
* @todo api
* @api
*/
ol.format.WKT.prototype.writeGeometry;

4
src/ol/format/wmscapabilitiesformat.js
View File

@@ -18,7 +18,7 @@ goog.require('ol.xml');
*
* @constructor
* @extends {ol.format.XML}
* @todo api
* @api
*/
ol.format.WMSCapabilities = function() {
@@ -38,7 +38,7 @@ goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
* @todo api
* @api
*/
ol.format.WMSCapabilities.prototype.read;