From d1ee4b8fed98034f188448da7587c11cc455925e Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Tue, 11 Mar 2014 20:38:13 -0400 Subject: [PATCH] Add documentation for the TopoJSON format. --- src/ol/format/topojsonformat.js | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/ol/format/topojsonformat.js b/src/ol/format/topojsonformat.js index 3095cf7078..3af47c2f5c 100644 --- a/src/ol/format/topojsonformat.js +++ b/src/ol/format/topojsonformat.js @@ -264,6 +264,16 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs, }; +/** + * Read all features from a TopoJSON source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} source Source. + * @return {Array.} Features. + */ +ol.format.TopoJSON.prototype.readFeatures; + + /** * @inheritDoc */ @@ -364,7 +374,11 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) { /** - * @inheritDoc + * Read the projection from a TopoJSON source. + * + * @function + * @param {ArrayBuffer|Document|Node|Object|string} object Source. + * @return {ol.proj.Projection} Projection. */ ol.format.TopoJSON.prototype.readProjection = function(object) { return this.defaultProjection_;