Add documentation for the TopoJSON format.

This commit is contained in:
Paul Spencer
2014-03-11 20:38:13 -04:00
parent a646577bd6
commit d1ee4b8fed
+15 -1
View File
@@ -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.<ol.Feature>} Features.
*/
ol.format.TopoJSON.prototype.readFeatures;
/** /**
* @inheritDoc * @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) { ol.format.TopoJSON.prototype.readProjection = function(object) {
return this.defaultProjection_; return this.defaultProjection_;