From abe953e4e5af4e321ea803d39bc24b164f69a678 Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Tue, 10 Jun 2014 09:08:43 -0400 Subject: [PATCH] Use @classdesc notation (continuing #2178) --- src/ol/kinetic.js | 3 +++ src/ol/render/canvas/canvasimmediate.js | 8 ++++++++ src/ol/tile.js | 3 +++ src/ol/tilecoord.js | 3 +++ src/ol/webgl/context.js | 3 +++ 5 files changed, 20 insertions(+) diff --git a/src/ol/kinetic.js b/src/ol/kinetic.js index d8e704391a..1980ba575b 100644 --- a/src/ol/kinetic.js +++ b/src/ol/kinetic.js @@ -7,6 +7,9 @@ goog.require('ol.animation'); /** + * @classdesc + * Implementation of inertial deceleration for map movement. + * * @constructor * @param {number} decay Rate of decay (must be negative). * @param {number} minVelocity Minimum velocity (pixels/millisecond). diff --git a/src/ol/render/canvas/canvasimmediate.js b/src/ol/render/canvas/canvasimmediate.js index a3d0412eb2..2825c97bf6 100644 --- a/src/ol/render/canvas/canvasimmediate.js +++ b/src/ol/render/canvas/canvasimmediate.js @@ -19,6 +19,14 @@ goog.require('ol.vec.Mat4'); /** + * @classdesc + * A concrete subclass of {@link ol.render.IVectorContext} that implements + * direct rendering of features and geometries to an HTML5 Canvas context. + * Instances of this class are created internally by the library and + * provided to application code as vectorContext member of the + * {@link ol.render.Event} object associated with postcompose, precompose and + * render events emitted by layers and maps. + * * @constructor * @implements {ol.render.IVectorContext} * @param {CanvasRenderingContext2D} context Context. diff --git a/src/ol/tile.js b/src/ol/tile.js index de2b6ef6cd..bd0b3f6e19 100644 --- a/src/ol/tile.js +++ b/src/ol/tile.js @@ -23,6 +23,9 @@ ol.TileState = { /** + * @classdesc + * Base class for tiles. + * * @constructor * @extends {goog.events.EventTarget} * @param {ol.TileCoord} tileCoord Tile coordinate. diff --git a/src/ol/tilecoord.js b/src/ol/tilecoord.js index 8d90fd393f..bbfb928a30 100644 --- a/src/ol/tilecoord.js +++ b/src/ol/tilecoord.js @@ -17,6 +17,9 @@ ol.QuadKeyCharCode = { /** + * @classdesc + * Represents the location of a tile in a tile grid. + * * @constructor * @param {number} z Zoom level. * @param {number} x X. diff --git a/src/ol/webgl/context.js b/src/ol/webgl/context.js index 78b98534af..158d3eef1c 100644 --- a/src/ol/webgl/context.js +++ b/src/ol/webgl/context.js @@ -19,6 +19,9 @@ ol.webgl.BufferCacheEntry; /** + * @classdesc + * A WebGL context for accessing low-level WebGL capabilities. + * * @constructor * @extends {goog.events.EventTarget} * @param {HTMLCanvasElement} canvas Canvas.