Harmonize jsdoc

This commit is contained in:
Simon Seyock
2021-02-02 11:44:44 +01:00
parent d6d18d46a8
commit f590cb3473
26 changed files with 86 additions and 86 deletions
+1 -1
View File
@@ -119,7 +119,7 @@ class WebGLArrayBuffer {
/**
* Returns a typed array constructor based on the given buffer type
* @param {number} type Buffer type, either ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER.
* @returns {Float32ArrayConstructor|Uint32ArrayConstructor} The typed array class to use for this buffer.
* @return {Float32ArrayConstructor|Uint32ArrayConstructor} The typed array class to use for this buffer.
*/
export function getArrayClassForType(type) {
switch (type) {
+2 -2
View File
@@ -963,7 +963,7 @@ class WebGLHelper extends Disposable {
/**
* Compute a stride in bytes based on a list of attributes
* @param {Array<AttributeDescription>} attributes Ordered list of attributes
* @returns {number} Stride, ie amount of values for each vertex in the vertex buffer
* @return {number} Stride, ie amount of values for each vertex in the vertex buffer
* @api
*/
export function computeAttributesStride(attributes) {
@@ -978,7 +978,7 @@ export function computeAttributesStride(attributes) {
/**
* Computes the size in byte of an attribute type.
* @param {AttributeType} type Attribute type
* @returns {number} The size in bytes
* @return {number} The size in bytes
*/
function getByteSizeFromType(type) {
switch (type) {
+1 -1
View File
@@ -285,7 +285,7 @@ class WebGLPostProcessingPass {
}
/**
* @returns {WebGLFramebuffer} Frame buffer
* @return {WebGLFramebuffer} Frame buffer
* @api
*/
getFrameBuffer() {
+1 -1
View File
@@ -125,7 +125,7 @@ class WebGLRenderTarget {
* If x and/or y are outside of existing data, an array filled with 0 is returned.
* @param {number} x Pixel coordinate
* @param {number} y Pixel coordinate
* @returns {Uint8Array} Integer array with one color value (4 components)
* @return {Uint8Array} Integer array with one color value (4 components)
* @api
*/
readPixel(x, y) {
+8 -8
View File
@@ -223,35 +223,35 @@ export class ShaderBuilder {
}
/**
* @returns {string} Previously set size expression
* @return {string} Previously set size expression
*/
getSizeExpression() {
return this.sizeExpression;
}
/**
* @returns {string} Previously set symbol offset expression
* @return {string} Previously set symbol offset expression
*/
getOffsetExpression() {
return this.offsetExpression;
}
/**
* @returns {string} Previously set color expression
* @return {string} Previously set color expression
*/
getColorExpression() {
return this.colorExpression;
}
/**
* @returns {string} Previously set texture coordinate expression
* @return {string} Previously set texture coordinate expression
*/
getTextureCoordinateExpression() {
return this.texCoordExpression;
}
/**
* @returns {string} Previously set fragment discard expression
* @return {string} Previously set fragment discard expression
*/
getFragmentDiscardExpression() {
return this.discardExpression;
@@ -272,7 +272,7 @@ export class ShaderBuilder {
*
* @param {boolean} [forHitDetection] If true, the shader will be modified to include hit detection variables
* (namely, hit color with encoded feature id).
* @returns {string} The full shader as a string.
* @return {string} The full shader as a string.
*/
getSymbolVertexShader(forHitDetection) {
const offsetMatrix = this.rotateWithView
@@ -363,7 +363,7 @@ ${varyings
*
* @param {boolean} [forHitDetection] If true, the shader will be modified to include hit detection variables
* (namely, hit color with encoded feature id).
* @returns {string} The full shader as a string.
* @return {string} The full shader as a string.
*/
getSymbolFragmentShader(forHitDetection) {
const hitDetectionBypass = forHitDetection
@@ -421,7 +421,7 @@ ${hitDetectionBypass}
* {@link module:ol/renderer/webgl/PointsLayer~WebGLPointsLayerRenderer}.
*
* @param {import("../style/LiteralStyle").LiteralStyle} style Literal style.
* @returns {StyleParseResult} Result containing shader params, attributes and uniforms.
* @return {StyleParseResult} Result containing shader params, attributes and uniforms.
*/
export function parseLiteralStyle(style) {
const symbStyle = style.symbol;