Remove unnecessary 'function' in jsdoc blocks
This commit is contained in:
@@ -41,7 +41,6 @@ class Event {
|
||||
|
||||
/**
|
||||
* Stop event propagation.
|
||||
* @function
|
||||
* @api
|
||||
*/
|
||||
preventDefault() {
|
||||
@@ -50,7 +49,6 @@ class Event {
|
||||
|
||||
/**
|
||||
* Stop event propagation.
|
||||
* @function
|
||||
* @api
|
||||
*/
|
||||
stopPropagation() {
|
||||
|
||||
@@ -76,7 +76,6 @@ class Target extends Disposable {
|
||||
* import("./Event.js").default|string} event Event object.
|
||||
* @return {boolean|undefined} `false` if anyone called preventDefault on the
|
||||
* event object or if any of the listeners returned false.
|
||||
* @function
|
||||
* @api
|
||||
*/
|
||||
dispatchEvent(event) {
|
||||
|
||||
@@ -67,7 +67,6 @@ export const focus = function(event) {
|
||||
*
|
||||
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
|
||||
* @return {boolean} True.
|
||||
* @function
|
||||
* @api
|
||||
*/
|
||||
export const always = TRUE;
|
||||
@@ -106,7 +105,6 @@ export const mouseActionButton = function(mapBrowserEvent) {
|
||||
*
|
||||
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
|
||||
* @return {boolean} False.
|
||||
* @function
|
||||
* @api
|
||||
*/
|
||||
export const never = FALSE;
|
||||
|
||||
@@ -90,7 +90,6 @@ class TextFeature extends FeatureFormat {
|
||||
/**
|
||||
* Read the projection from the source.
|
||||
*
|
||||
* @function
|
||||
* @param {Document|Node|Object|string} source Source.
|
||||
* @return {import("../proj/Projection.js").default} Projection.
|
||||
* @api
|
||||
@@ -111,7 +110,6 @@ class TextFeature extends FeatureFormat {
|
||||
/**
|
||||
* Encode a feature as a string.
|
||||
*
|
||||
* @function
|
||||
* @param {import("../Feature.js").default} feature Feature.
|
||||
* @param {import("./Feature.js").WriteOptions=} opt_options Write options.
|
||||
* @return {string} Encoded feature.
|
||||
@@ -154,7 +152,6 @@ class TextFeature extends FeatureFormat {
|
||||
/**
|
||||
* Write a single geometry.
|
||||
*
|
||||
* @function
|
||||
* @param {import("../geom/Geometry.js").default} geometry Geometry.
|
||||
* @param {import("./Feature.js").WriteOptions=} opt_options Write options.
|
||||
* @return {string} Geometry.
|
||||
|
||||
@@ -79,7 +79,6 @@ class XMLFeature extends FeatureFormat {
|
||||
/**
|
||||
* Read all features from a feature collection.
|
||||
*
|
||||
* @function
|
||||
* @param {Document|Node|Object|string} source Source.
|
||||
* @param {import("./Feature.js").ReadOptions=} opt_options Options.
|
||||
* @return {Array<import("../Feature.js").default>} Features.
|
||||
|
||||
@@ -158,10 +158,8 @@ class Geometry extends BaseObject {
|
||||
* https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm
|
||||
* Douglas Peucker} algorithm. For polygons, a quantization-based
|
||||
* simplification is used to preserve topology.
|
||||
* @function
|
||||
* @param {number} tolerance The tolerance distance for simplification.
|
||||
* @return {import("./Geometry.js").default} A new, simplified version of the original
|
||||
* geometry.
|
||||
* @return {import("./Geometry.js").default} A new, simplified version of the original geometry.
|
||||
* @api
|
||||
*/
|
||||
simplify(tolerance) {
|
||||
|
||||
Reference in New Issue
Block a user