Fixed some jsdoc issues.

This commit is contained in:
Simon Seyock
2021-02-02 12:08:33 +01:00
parent f590cb3473
commit 808868ad1f
6 changed files with 5 additions and 9 deletions

View File

@@ -1,5 +1,5 @@
/**
* @filedesc
* @fileoverview
* Inlines option params from typedefs
*/

View File

@@ -190,9 +190,9 @@ function generateSourceFiles(sourceFiles) {
* for display purposes. This function mutates the original arrays.
*
* @private
* @param {Array<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to
* @param {Array<module:jsdoc/doclet.Doclet>} doclets The array of classes and functions to
* check.
* @param {Array<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search.
* @param {Array<module:jsdoc/doclet.Doclet>} modules The array of module doclets to search.
*/
function attachModuleSymbols(doclets, modules) {
const symbols = {};

View File

@@ -32,10 +32,6 @@ import {listen, unlistenByKey} from '../events.js';
* visible.
* @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
* be visible.
* @property {number} [minZoom] The minimum view zoom level (exclusive) above which this layer will be
* visible.
* @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
* be visible.
* @property {Array<import("./Base.js").default>|import("../Collection.js").default<import("./Base.js").default>} [layers] Child layers.
*/

View File

@@ -163,6 +163,7 @@ class ImageStyle {
/**
* Get the image pixel ratio.
* @param {number} pixelRatio Pixel ratio.
* @return {number} Pixel ratio.
*/
getPixelRatio(pixelRatio) {
return 1;

View File

@@ -243,6 +243,7 @@ class RegularShape extends ImageStyle {
/**
* Get the image pixel ratio.
* @param {number} pixelRatio Pixel ratio.
* @return {number} Pixel ratio.
*/
getPixelRatio(pixelRatio) {
return pixelRatio;

View File

@@ -64,8 +64,6 @@ function formatSymbolExport(symbol, namespaces, imports) {
/**
* Generate export code given a list symbol names.
* @param {Array<Object>} symbols List of symbols.
* @param {Object<string, string>} namespaces Already defined namespaces.
* @param {Array<string>} imports List of all imports.
* @return {string} Export code.
*/
function generateExports(symbols) {