From a646577bd6151fa3ebe33c4b9b3ab62970905521 Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Tue, 11 Mar 2014 20:35:47 -0400 Subject: [PATCH] Add documentation for the KML format. --- src/ol/format/kmlformat.exports | 1 - src/ol/format/kmlformat.js | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/ol/format/kmlformat.exports b/src/ol/format/kmlformat.exports index 72929f6fd4..edafad12f2 100644 --- a/src/ol/format/kmlformat.exports +++ b/src/ol/format/kmlformat.exports @@ -1,6 +1,5 @@ @exportSymbol ol.format.KML @exportProperty ol.format.KML.prototype.readFeature @exportProperty ol.format.KML.prototype.readFeatures -@exportProperty ol.format.KML.prototype.readGeometry @exportProperty ol.format.KML.prototype.readName @exportProperty ol.format.KML.prototype.readProjection diff --git a/src/ol/format/kmlformat.js b/src/ol/format/kmlformat.js index 7088973182..6e049f3416 100644 --- a/src/ol/format/kmlformat.js +++ b/src/ol/format/kmlformat.js @@ -1443,6 +1443,16 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) { }; +/** + * Read the first feature from a KML source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {ol.Feature} Feature. + */ +ol.format.KML.prototype.readFeature; + + /** * @inheritDoc */ @@ -1462,6 +1472,16 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) { }; +/** + * Read all features from a KML source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {Array.} Features. + */ +ol.format.KML.prototype.readFeatures; + + /** * @inheritDoc */ @@ -1573,6 +1593,16 @@ ol.format.KML.prototype.readNameFromNode = function(node) { }; +/** + * Read the projection from a KML source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {ol.proj.Projection} Projection. + */ +ol.format.KML.prototype.readProjection; + + /** * @inheritDoc */