From d7c696fc76b93ef4e7c9347be6e50be7d2fadc3f Mon Sep 17 00:00:00 2001 From: Bruno Binet Date: Fri, 11 Oct 2013 17:00:23 +0200 Subject: [PATCH] Improve doc for stopEvent and insertFirst options --- src/objectliterals.jsdoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 3f1508a2ad..3cb335e2b9 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -80,8 +80,12 @@ * @property {ol.OverlayPositioning|undefined} positioning Positioning. * @property {boolean|undefined} stopEvent Whether event propagation to the map * should be stopped. Default is `false`. + * If `stopEvent` is `true`, the overlay is placed in the same container as + * that of the controls (`ol-overlaycontainer-stopevent`). * @property {boolean|undefined} insertFirst Whether the overlay is inserted * first in the container div, or appended. Default is `false`. + * This is usually used in conjunction with `stopEvent: true` so the + * overlay is below controls. * @todo stability experimental */