Add documentation for ol.format.Feature public API methods intended to be inherited by subclasses.

src/ol/format/featureformat.js

@@ -5,6 +5,10 @@ goog.require('goog.functions');
 
 
 /**
+ * ol.format.Feature subclasses provide the ability to decode and encode
+ * {@link ol.Feature} objects from a variety of commonly used geospatial
+ * file formats.  See the documentation for each format for more details.
+ *
  * @constructor
  */
 ol.format.Feature = function() {
@@ -24,6 +28,8 @@ ol.format.Feature.prototype.getType = goog.abstractMethod;
 
 
 /**
+ * Read a single feature from a source.
+ *
  * @param {ArrayBuffer|Document|Node|Object|string} source Source.
  * @return {ol.Feature} Feature.
  */
@@ -31,6 +37,8 @@ ol.format.Feature.prototype.readFeature = goog.abstractMethod;
 
 
 /**
+ * Read all features from a source.
+ *
  * @param {ArrayBuffer|Document|Node|Object|string} source Source.
  * @return {Array.<ol.Feature>} Features.
  */
@@ -38,6 +46,8 @@ ol.format.Feature.prototype.readFeatures = goog.abstractMethod;
 
 
 /**
+ * Read a single geometry from a source.
+ *
  * @param {ArrayBuffer|Document|Node|Object|string} source Source.
  * @return {ol.geom.Geometry} Geometry.
  */
@@ -45,6 +55,8 @@ ol.format.Feature.prototype.readGeometry = goog.abstractMethod;
 
 
 /**
+ * Read the projection from a source.
+ *
  * @param {ArrayBuffer|Document|Node|Object|string} source Source.
  * @return {ol.proj.Projection} Projection.
  */
@@ -52,6 +64,8 @@ ol.format.Feature.prototype.readProjection = goog.abstractMethod;
 
 
 /**
+ * Encode a feature in this format.
+ *
  * @param {ol.Feature} feature Feature.
  * @return {ArrayBuffer|Node|Object|string} Result.
  */
@@ -59,6 +73,8 @@ ol.format.Feature.prototype.writeFeature = goog.abstractMethod;
 
 
 /**
+ * Encode an array of features in this format.
+ *
  * @param {Array.<ol.Feature>} features Features.
  * @return {ArrayBuffer|Node|Object|string} Result.
  */
@@ -66,6 +82,8 @@ ol.format.Feature.prototype.writeFeatures = goog.abstractMethod;
 
 
 /**
+ * Write a single geometry in this format.
+ *
  * @param {ol.geom.Geometry} geometry Geometry.
  * @return {ArrayBuffer|Node|Object|string} Node.
  */