Set api annotation on classdesc, not constructor

This commit is contained in:
ahocevar
2018-07-21 17:25:22 +02:00
parent 2767ddfdc7
commit bbe0a66d07
101 changed files with 484 additions and 382 deletions
+5 -1
View File
@@ -13,11 +13,15 @@ import {layerRendererConstructors} from './Map.js';
import IntermediateCanvasRenderer from './IntermediateCanvas.js';
import {create as createTransform, compose as composeTransform} from '../../transform.js';
/**
* @classdesc
* Canvas renderer for image layers.
* @api
*/
class CanvasImageLayerRenderer extends IntermediateCanvasRenderer {
/**
* @param {module:ol/layer/Image|module:ol/layer/Vector} imageLayer Image or vector layer.
* @api
*/
constructor(imageLayer) {
+5 -2
View File
@@ -19,12 +19,15 @@ import SourceState from '../../source/State.js';
*/
export const layerRendererConstructors = [];
/**
* @classdesc
* Canvas map renderer.
* @api
*/
class CanvasMapRenderer extends MapRenderer {
/**
* @param {module:ol/PluggableMap} map Map.
* @api
*/
constructor(map) {
super(map);
+5 -1
View File
@@ -11,12 +11,16 @@ import {containsExtent, createEmpty, equals, getIntersection, isEmpty} from '../
import IntermediateCanvasRenderer from '../canvas/IntermediateCanvas.js';
import {create as createTransform, compose as composeTransform} from '../../transform.js';
/**
* @classdesc
* Canvas renderer for tile layers.
* @api
*/
class CanvasTileLayerRenderer extends IntermediateCanvasRenderer {
/**
* @param {module:ol/layer/Tile|module:ol/layer/VectorTile} tileLayer Tile layer.
* @param {boolean=} opt_noContext Skip the context creation.
* @api
*/
constructor(tileLayer, opt_noContext) {
+5 -1
View File
@@ -15,11 +15,15 @@ import CanvasReplayGroup from '../../render/canvas/ReplayGroup.js';
import CanvasLayerRenderer from '../canvas/Layer.js';
import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance, getSquaredTolerance as getSquaredRenderTolerance, renderFeature} from '../vector.js';
/**
* @classdesc
* Canvas renderer for vector layers.
* @api
*/
class CanvasVectorLayerRenderer extends CanvasLayerRenderer {
/**
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
constructor(vectorLayer) {
+5 -1
View File
@@ -47,11 +47,15 @@ const VECTOR_REPLAYS = {
};
/**
* @classdesc
* Canvas renderer for vector tile layers.
* @api
*/
class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
/**
* @param {module:ol/layer/VectorTile} layer VectorTile layer.
* @api
*/
constructor(layer) {
+5 -1
View File
@@ -21,12 +21,16 @@ import {
import {CLAMP_TO_EDGE} from '../../webgl.js';
import {createTexture} from '../../webgl/Context.js';
/**
* @classdesc
* WebGL renderer for image layers.
* @api
*/
class WebGLImageLayerRenderer extends WebGLLayerRenderer {
/**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Image} imageLayer Tile layer.
* @api
*/
constructor(mapRenderer, imageLayer) {
+5 -1
View File
@@ -37,11 +37,15 @@ import ContextEventType from '../../webgl/ContextEventType.js';
const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024;
/**
* @classdesc
* WebGL map renderer.
* @api
*/
class WebGLMapRenderer extends MapRenderer {
/**
* @param {module:ol/PluggableMap} map Map.
* @api
*/
constructor(map) {
super(map);
+5 -1
View File
@@ -24,12 +24,16 @@ import {
import {COLOR_BUFFER_BIT, BLEND, ARRAY_BUFFER, FLOAT, LINEAR, TRIANGLE_STRIP} from '../../webgl.js';
import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @classdesc
* WebGL renderer for tile layers.
* @api
*/
class WebGLTileLayerRenderer extends WebGLLayerRenderer {
/**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Tile} tileLayer Tile layer.
* @api
*/
constructor(mapRenderer, tileLayer) {
+6 -1
View File
@@ -10,12 +10,17 @@ import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance,
import WebGLLayerRenderer from '../webgl/Layer.js';
import {apply as applyTransform} from '../../transform.js';
/**
* @classdesc
* WebGL renderer for vector layers.
* @api
*/
class WebGLVectorLayerRenderer extends WebGLLayerRenderer {
/**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
constructor(mapRenderer, vectorLayer) {