From f83fedb9e1446527d11d1ec3b846000579cd00e3 Mon Sep 17 00:00:00 2001 From: ahocevar Date: Fri, 7 Jun 2013 14:54:09 +0200 Subject: [PATCH] API doc improvements --- src/objectliterals.jsdoc | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 6631096902..47630acd77 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -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.):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.