Add missing event documentation and stability tags

This commit is contained in:
ahocevar
2014-03-26 14:04:58 +01:00
parent 932cab12af
commit a3b5376520
24 changed files with 121 additions and 11 deletions

View File

@@ -9,8 +9,20 @@ goog.require('ol.render.IVectorContext');
* @enum {string}
*/
ol.render.EventType = {
/**
* @event ol.render.Event#postcompose
* @todo stability experimental
*/
POSTCOMPOSE: 'postcompose',
/**
* @event ol.render.Event#precompose
* @todo stability experimental
*/
PRECOMPOSE: 'precompose',
/**
* @event ol.render.Event#render
* @todo stability experimental
*/
RENDER: 'render'
};
@@ -35,21 +47,29 @@ ol.render.Event = function(
/**
* @type {ol.render.IVectorContext|undefined}
* @todo stability experimental
*/
this.vectorContext = opt_vectorContext;
/**
* @type {oli.FrameState|undefined}
* @todo stability experimental
*/
this.frameState = opt_frameState;
/**
* Canvas context. Only available when a Canvas renderer is used,
* null otherwise.
* @type {CanvasRenderingContext2D|null|undefined}
* @todo stability experimental
*/
this.context = opt_context;
/**
* WebGL context. Only available when a WebGL renderer is used, null
* otherwise.
* @type {ol.webgl.Context|null|undefined}
* @todo stability experimental
*/
this.glContext = opt_glContext;