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

Annotations for exports

Browse Source
This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ol/format/geojsonformat.exports
View File

@@ -1,8 +0,0 @@
@exportSymbol ol.format.GeoJSON
@exportProperty ol.format.GeoJSON.prototype.readFeature
@exportProperty ol.format.GeoJSON.prototype.readFeatures
@exportProperty ol.format.GeoJSON.prototype.readGeometry
@exportProperty ol.format.GeoJSON.prototype.readProjection
@exportProperty ol.format.GeoJSON.prototype.writeFeature
@exportProperty ol.format.GeoJSON.prototype.writeFeatures
@exportProperty ol.format.GeoJSON.prototype.writeGeometry

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

@@ -27,6 +27,7 @@ goog.require('ol.proj');
* @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON = function(opt_options) {
@@ -322,6 +323,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.GeoJSON.prototype.readFeature;
@@ -333,6 +335,7 @@ ol.format.GeoJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.GeoJSON.prototype.readFeatures;
@@ -386,6 +389,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo api
*/
ol.format.GeoJSON.prototype.readGeometry;
@@ -404,6 +408,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
*
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.GeoJSON.prototype.readProjection = function(object) {
var geoJSONObject = /** @type {GeoJSONObject} */ (object);
@@ -433,6 +438,7 @@ ol.format.GeoJSON.prototype.readProjection = function(object) {
* @function
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -468,6 +474,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeatures;

5
src/ol/format/gpxformat.exports
View File

@@ -1,5 +0,0 @@
@exportSymbol ol.format.GPX
@exportProperty ol.format.GPX.prototype.readFeature
@exportProperty ol.format.GPX.prototype.readFeatures
@exportProperty ol.format.GPX.prototype.readProjection
@exportProperty ol.format.GPX.prototype.writeFeatures

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

@@ -20,6 +20,7 @@ goog.require('ol.xml');
* @constructor
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.GPX = function() {
goog.base(this);
@@ -369,6 +370,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.GPX.prototype.readFeature;
@@ -399,6 +401,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.GPX.prototype.readFeatures;
@@ -430,6 +433,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.GPX.prototype.readProjection;
@@ -805,6 +809,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
*/
ol.format.GPX.prototype.writeFeatures;

4
src/ol/format/igcformat.exports
View File

@@ -1,4 +0,0 @@
@exportSymbol ol.format.IGC
@exportProperty ol.format.IGC.prototype.readFeature
@exportProperty ol.format.IGC.prototype.readFeatures
@exportProperty ol.format.IGC.prototype.readProjection

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

@@ -26,6 +26,7 @@ ol.format.IGCZ = {
* @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.IGC = function(opt_options) {
@@ -91,6 +92,7 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.IGC.prototype.readFeature;
@@ -176,6 +178,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.IGC.prototype.readFeatures;
@@ -199,6 +202,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.IGC.prototype.readProjection;

5
src/ol/format/kmlformat.exports
View File

@@ -1,5 +0,0 @@
@exportSymbol ol.format.KML
@exportProperty ol.format.KML.prototype.readFeature
@exportProperty ol.format.KML.prototype.readFeatures
@exportProperty ol.format.KML.prototype.readName
@exportProperty ol.format.KML.prototype.readProjection

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

@@ -55,6 +55,7 @@ ol.format.KMLGxTrackObject_;
* @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.KML = function(opt_options) {
@@ -1450,6 +1451,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.KML.prototype.readFeature;
@@ -1478,6 +1480,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.KML.prototype.readFeatures;
@@ -1596,6 +1599,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.KML.prototype.readProjection;

1
src/ol/format/osmxmlformat.exports
View File

@@ -1 +0,0 @@
@exportSymbol ol.format.OSMXML

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

@@ -18,6 +18,7 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XMLFeature}
* @todo api
*/
ol.format.OSMXML = function() {
goog.base(this);

3
src/ol/format/topojsonformat.exports
View File

@@ -1,3 +0,0 @@
@exportSymbol ol.format.TopoJSON
@exportProperty ol.format.TopoJSON.prototype.readFeatures
@exportProperty ol.format.TopoJSON.prototype.readProjection

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

@@ -20,6 +20,7 @@ goog.require('ol.proj');
* @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.TopoJSON = function(opt_options) {
@@ -271,6 +272,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.TopoJSON.prototype.readFeatures;
@@ -380,6 +382,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
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {
return this.defaultProjection_;

6
src/ol/format/wfsformat.exports
View File

@@ -1,6 +0,0 @@
@exportSymbol ol.format.WFS
@exportProperty ol.format.WFS.prototype.readFeatures
@exportProperty ol.format.WFS.prototype.readTransactionResponse
@exportProperty ol.format.WFS.prototype.readFeatureCollectionMetadata
@exportProperty ol.format.WFS.prototype.writeGetFeature
@exportProperty ol.format.WFS.prototype.writeTransaction

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

@@ -18,6 +18,7 @@ goog.require('ol.xml');
* Optional configuration object.
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.WFS = function(opt_options) {
var options = /** @type {olx.format.WFSOptions} */
@@ -92,6 +93,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
*/
ol.format.WFS.prototype.readTransactionResponse = function(source) {
if (ol.xml.isDocument(source)) {
@@ -113,6 +115,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
*/
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
if (ol.xml.isDocument(source)) {
@@ -549,6 +552,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @todo api
*/
ol.format.WFS.prototype.writeGetFeature = function(options) {
var node = ol.xml.createElementNS('http://www.opengis.net/wfs',
@@ -600,6 +604,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
*/
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
options) {

2
src/ol/format/wmscapabilitiesformat.exports
View File

@@ -1,2 +0,0 @@
@exportSymbol ol.format.WMSCapabilities
@exportProperty ol.format.WMSCapabilities.prototype.read

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

@@ -15,6 +15,7 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XML}
* @todo api
*/
ol.format.WMSCapabilities = function() {
@@ -28,6 +29,17 @@ ol.format.WMSCapabilities = function() {
goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
/**
* Read a WMS capabilities document.
*
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
* @todo api
*/
ol.format.WMSCapabilities.prototype.read;
/**
* @param {Document} doc Document.
* @return {Object} WMS Capability object.