Remove @extends and @constructor annotations
This commit is contained in:
+17
-17
@@ -21,24 +21,24 @@ import {createCanvasContext2D} from '../dom.js';
|
||||
* @property {HTMLCanvasElement} image
|
||||
*/
|
||||
|
||||
/**
|
||||
* This class facilitates the creation of image atlases.
|
||||
*
|
||||
* Images added to an atlas will be rendered onto a single
|
||||
* atlas canvas. The distribution of images on the canvas is
|
||||
* managed with the bin packing algorithm described in:
|
||||
* http://www.blackpawn.com/texts/lightmaps/
|
||||
*
|
||||
* @constructor
|
||||
* @struct
|
||||
* @param {number} size The size in pixels of the sprite image.
|
||||
* @param {number} space The space in pixels between images.
|
||||
* Because texture coordinates are float values, the edges of
|
||||
* images might not be completely correct (in a way that the
|
||||
* edges overlap when being rendered). To avoid this we add a
|
||||
* padding around each image.
|
||||
*/
|
||||
class Atlas {
|
||||
|
||||
/**
|
||||
* This class facilitates the creation of image atlases.
|
||||
*
|
||||
* Images added to an atlas will be rendered onto a single
|
||||
* atlas canvas. The distribution of images on the canvas is
|
||||
* managed with the bin packing algorithm described in:
|
||||
* http://www.blackpawn.com/texts/lightmaps/
|
||||
*
|
||||
* @struct
|
||||
* @param {number} size The size in pixels of the sprite image.
|
||||
* @param {number} space The space in pixels between images.
|
||||
* Because texture coordinates are float values, the edges of
|
||||
* images might not be completely correct (in a way that the
|
||||
* edges overlap when being rendered). To avoid this we add a
|
||||
* padding around each image.
|
||||
*/
|
||||
constructor(size, space) {
|
||||
|
||||
/**
|
||||
|
||||
@@ -41,24 +41,23 @@ const INITIAL_ATLAS_SIZE = 256;
|
||||
const MAX_ATLAS_SIZE = -1;
|
||||
|
||||
|
||||
/**
|
||||
* Manages the creation of image atlases.
|
||||
*
|
||||
* Images added to this manager will be inserted into an atlas, which
|
||||
* will be used for rendering.
|
||||
* The `size` given in the constructor is the size for the first
|
||||
* atlas. After that, when new atlases are created, they will have
|
||||
* twice the size as the latest atlas (until `maxSize` is reached).
|
||||
*
|
||||
* If an application uses many images or very large images, it is recommended
|
||||
* to set a higher `size` value to avoid the creation of too many atlases.
|
||||
*
|
||||
* @constructor
|
||||
* @struct
|
||||
* @api
|
||||
* @param {module:ol/style/AtlasManager~Options=} opt_options Options.
|
||||
*/
|
||||
class AtlasManager {
|
||||
/**
|
||||
* Manages the creation of image atlases.
|
||||
*
|
||||
* Images added to this manager will be inserted into an atlas, which
|
||||
* will be used for rendering.
|
||||
* The `size` given in the constructor is the size for the first
|
||||
* atlas. After that, when new atlases are created, they will have
|
||||
* twice the size as the latest atlas (until `maxSize` is reached).
|
||||
*
|
||||
* If an application uses many images or very large images, it is recommended
|
||||
* to set a higher `size` value to avoid the creation of too many atlases.
|
||||
*
|
||||
* @struct
|
||||
* @api
|
||||
* @param {module:ol/style/AtlasManager~Options=} opt_options Options.
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
const options = opt_options || {};
|
||||
|
||||
@@ -25,9 +25,7 @@ class CircleStyle extends RegularShape {
|
||||
* @classdesc
|
||||
* Set circle style for vector features.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/Circle~Options=} opt_options Options.
|
||||
* @extends {module:ol/style/RegularShape}
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
@@ -16,12 +16,12 @@ import {asString} from '../color.js';
|
||||
/**
|
||||
* @classdesc
|
||||
* Set fill style for vector features.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/Fill~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
class Fill {
|
||||
/**
|
||||
* @param {module:ol/style/Fill~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
const options = opt_options || {};
|
||||
|
||||
@@ -57,9 +57,7 @@ class Icon extends ImageStyle {
|
||||
* @classdesc
|
||||
* Set icon style for vector features.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/Icon~Options=} opt_options Options.
|
||||
* @extends {module:ol/style/Image}
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
@@ -11,14 +11,12 @@ import {shared as iconImageCache} from '../style/IconImageCache.js';
|
||||
|
||||
class IconImage extends EventTarget {
|
||||
/**
|
||||
* @constructor
|
||||
* @param {HTMLImageElement|HTMLCanvasElement} image Image.
|
||||
* @param {string|undefined} src Src.
|
||||
* @param {module:ol/size~Size} size Size.
|
||||
* @param {?string} crossOrigin Cross origin.
|
||||
* @param {module:ol/ImageState} imageState Image state.
|
||||
* @param {module:ol/color~Color} color Color.
|
||||
* @extends {module:ol/events/EventTarget}
|
||||
*/
|
||||
constructor(image, src, size, crossOrigin, imageState, color) {
|
||||
|
||||
|
||||
@@ -5,7 +5,6 @@ import {asString} from '../color.js';
|
||||
|
||||
/**
|
||||
* Singleton class. Available through {@link module:ol/style/IconImageCache~shared}.
|
||||
* @constructor
|
||||
*/
|
||||
class IconImageCache {
|
||||
constructor() {
|
||||
|
||||
@@ -18,13 +18,12 @@
|
||||
* A base class used for creating subclasses and not instantiated in
|
||||
* apps. Base class for {@link module:ol/style/Icon~Icon}, {@link module:ol/style/Circle~CircleStyle} and
|
||||
* {@link module:ol/style/RegularShape~RegularShape}.
|
||||
*
|
||||
* @constructor
|
||||
* @abstract
|
||||
* @param {module:ol/style/Image~Options} options Options.
|
||||
* @api
|
||||
*/
|
||||
class ImageStyle {
|
||||
/**
|
||||
* @param {module:ol/style/Image~Options} options Options.
|
||||
* @api
|
||||
*/
|
||||
constructor(options) {
|
||||
|
||||
/**
|
||||
|
||||
@@ -53,9 +53,7 @@ class RegularShape extends ImageStyle {
|
||||
* a regular polygon when `radius` is provided, or a star when `radius1` and
|
||||
* `radius2` are provided.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/RegularShape~Options} options Options.
|
||||
* @extends {module:ol/style/Image}
|
||||
* @api
|
||||
*/
|
||||
constructor(options) {
|
||||
|
||||
@@ -26,12 +26,13 @@ import {getUid} from '../util.js';
|
||||
* Note that the defaults given are the Canvas defaults, which will be used if
|
||||
* option is not defined. The `get` functions return whatever was entered in
|
||||
* the options; they will not return the default.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/Stroke~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
class Stroke {
|
||||
|
||||
/**
|
||||
* @param {module:ol/style/Stroke~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
const options = opt_options || {};
|
||||
|
||||
@@ -143,13 +143,13 @@ import Stroke from '../style/Stroke.js';
|
||||
* Container for vector feature rendering styles. Any changes made to the style
|
||||
* or its children through `set*()` methods will not take effect until the
|
||||
* feature or layer that uses the style is re-rendered.
|
||||
*
|
||||
* @constructor
|
||||
* @struct
|
||||
* @param {module:ol/style/Style~Options=} opt_options Style options.
|
||||
* @api
|
||||
*/
|
||||
class Style {
|
||||
|
||||
/**
|
||||
* @param {module:ol/style/Style~Options=} opt_options Style options.
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
const options = opt_options || {};
|
||||
|
||||
@@ -48,12 +48,13 @@ const DEFAULT_FILL_COLOR = '#333';
|
||||
/**
|
||||
* @classdesc
|
||||
* Set text style for vector features.
|
||||
*
|
||||
* @constructor
|
||||
* @param {module:ol/style/Text~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
class Text {
|
||||
|
||||
/**
|
||||
* @param {module:ol/style/Text~Options=} opt_options Options.
|
||||
* @api
|
||||
*/
|
||||
constructor(opt_options) {
|
||||
|
||||
const options = opt_options || {};
|
||||
|
||||
Reference in New Issue
Block a user