From 37feb7db6457f75b58974198253a1d404816f511 Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Tue, 11 Mar 2014 20:29:16 -0400 Subject: [PATCH] Add documentation for the IGC format. --- src/ol/format/igcformat.exports | 1 + src/ol/format/igcformat.js | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/src/ol/format/igcformat.exports b/src/ol/format/igcformat.exports index f5faa5c4fb..6a6acf7e15 100644 --- a/src/ol/format/igcformat.exports +++ b/src/ol/format/igcformat.exports @@ -1,3 +1,4 @@ @exportSymbol ol.format.IGC @exportProperty ol.format.IGC.prototype.readFeature @exportProperty ol.format.IGC.prototype.readFeatures +@exportProperty ol.format.IGC.prototype.readProjection diff --git a/src/ol/format/igcformat.js b/src/ol/format/igcformat.js index 449abe3e39..8be575dd04 100644 --- a/src/ol/format/igcformat.js +++ b/src/ol/format/igcformat.js @@ -85,6 +85,16 @@ ol.format.IGC.prototype.getExtensions = function() { }; +/** + * Read the feature from the IGC source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {ol.Feature} Feature. + */ +ol.format.IGC.prototype.readFeature; + + /** * @inheritDoc */ @@ -156,6 +166,17 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) { }; +/** + * Read the feature from the source. As IGC sources contain a single + * feature, this will return the feature in an array. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {Array.} Features. + */ +ol.format.IGC.prototype.readFeatures; + + /** * @inheritDoc */ @@ -169,6 +190,16 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) { }; +/** + * Read the projection from the IGC source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {ol.proj.Projection} Projection. + */ +ol.format.IGC.prototype.readProjection; + + /** * @inheritDoc */