Document the correct render events

This commit is contained in:
ahocevar
2019-01-31 14:05:10 +01:00
parent b76626071b
commit 47679a9686
5 changed files with 5 additions and 10 deletions

View File

@@ -52,10 +52,6 @@ import CompositeMapRenderer from './renderer/Composite.js';
* options or added with `addLayer` can be groups, which can contain further * options or added with `addLayer` can be groups, which can contain further
* groups, and so on. * groups, and so on.
* *
* @fires import("./MapBrowserEvent.js").MapBrowserEvent
* @fires import("./MapEvent.js").MapEvent
* @fires module:ol/render/Event~RenderEvent#postcompose
* @fires module:ol/render/Event~RenderEvent#precompose
* @api * @api
*/ */
class Map extends PluggableMap { class Map extends PluggableMap {

View File

@@ -124,9 +124,9 @@ import {create as createTransform, apply as applyTransform} from './transform.js
/** /**
* @fires import("./MapBrowserEvent.js").MapBrowserEvent * @fires import("./MapBrowserEvent.js").MapBrowserEvent
* @fires import("./MapEvent.js").MapEvent * @fires import("./MapEvent.js").MapEvent
* @fires module:ol/render/Event~RenderEvent#postcompose * @fires import("./render/Event.js").default#precompose
* @fires module:ol/render/Event~RenderEvent#precompose * @fires import("./render/Event.js").default#postcompose
* @fires module:ol/render/Event~RenderEvent#rendercomplete * @fires import("./render/Event.js").default#rendercomplete
* @api * @api
*/ */
class PluggableMap extends BaseObject { class PluggableMap extends BaseObject {

View File

@@ -34,7 +34,6 @@ import Layer from './Layer.js';
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @fires import("../render/Event.js").RenderEvent
* @api * @api
*/ */
class BaseImageLayer extends Layer { class BaseImageLayer extends Layer {

View File

@@ -18,7 +18,6 @@ import CanvasImageLayerRenderer from '../renderer/canvas/ImageLayer.js';
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @fires import("../render/Event.js").RenderEvent
* @api * @api
*/ */
class ImageLayer extends BaseImageLayer { class ImageLayer extends BaseImageLayer {

View File

@@ -60,7 +60,8 @@ import SourceState from '../source/State.js';
* *
* A generic `change` event is fired when the state of the source changes. * A generic `change` event is fired when the state of the source changes.
* *
* @fires import("../render/Event.js").RenderEvent * @fires import("../render/Event.js").RenderEvent#prerender
* @fires import("../render/Event.js").RenderEvent#postrender
*/ */
class Layer extends BaseLayer { class Layer extends BaseLayer {
/** /**