API doc improvements

This commit is contained in:
ahocevar
2013-06-07 14:54:09 +02:00
parent 3a6c7cf204
commit f83fedb9e1

View File

@@ -16,7 +16,8 @@
* passed `layers` array or in the layer collection as returned from
* `ol.Map#getLayers()` if no `layers` were provided.
* @property {function(Object)|undefined} error Callback for unsuccessful
* queries.
* queries. Note that queries with no matching features trigger the success
* callback, not the error callback.
*/
/**
@@ -30,7 +31,8 @@
* array or in the layer collection as returned from `ol.Map#getLayers()` if
* no layers were provided.
* @property {function(Object)|undefined} error Callback for unsuccessful
* queries.
* queries. Note that queries with no matching features trigger the success
* callback, not the error callback.
*/
/**
@@ -302,9 +304,9 @@
/**
* @typedef {Object} ol.layer.VectorLayerOptions
* @property {function(Array.<ol.Feature>):string|
* undefined} transformFeatureInfo Function to render an array of features
* into feature info markup. If not provided, a comma separated list the
* unique ids of the resulting features will be returned.
* undefined} getTransformFeatureInfo Function to render an array of
* features into feature info markup. If not provided, a comma separated
* list of the unique ids of the resulting features will be returned.
* @property {number|undefined} opacity Opacity. 0-1. Default is 1.
* @property {ol.source.Source} source Source for this layer.
* @property {ol.style.Style|undefined} style Style.