Remove ol/typedefs.js

This commit is contained in:
Tim Schaub
2018-04-19 18:22:04 -06:00
parent 99efb052f2
commit 7c35139e90
3 changed files with 11 additions and 35 deletions

View File

@@ -176,7 +176,6 @@ The minimum config file looks like this:
"ol.ENABLE_WEBGL=false"
],
"js": [
"node_modules/openlayers/src/ol/typedefs.js",
"node_modules/openlayers/externs/oli.js"
],
"extra_annotation_name": [
@@ -227,7 +226,6 @@ Here is a version of `config.json` with more compilation checks enabled:
"ol.ENABLE_WEBGL=false"
],
"js": [
"node_modules/openlayers/src/ol/typedefs.js",
"node_modules/openlayers/externs/oli.js"
],
"jscomp_error": [

View File

@@ -21,6 +21,15 @@ import SourceState from '../source/State.js';
import VectorEventType from '../source/VectorEventType.js';
import RBush from '../structs/RBush.js';
/**
* A function that takes an {@link module:ol/extent~Extent} and a resolution as arguments, and
* returns an array of {@link module:ol/extent~Extent} with the extents to load. Usually this
* is one of the standard {@link ol.loadingstrategy} strategies.
*
* @typedef {function(module:ol/extent~Extent, number): Array.<module:ol/extent~Extent>} LoadingStrategy
* @api
*/
/**
* @classdesc
@@ -95,7 +104,7 @@ inherits(VectorSourceEvent, Event);
* Setting this to `false` (e.g. for sources with polygons that represent administrative
* boundaries or TopoJSON sources) allows the renderer to optimise fill and
* stroke operations.
* @property {ol.LoadingStrategy} [strategy] The loading strategy to use.
* @property {module:ol/source/Vector~LoadingStrategy} [strategy] The loading strategy to use.
* By default an {@link ol.loadingstrategy.all}
* strategy is used, a one-off strategy which loads all features at once.
* @property {string|module:ol/Feature~FeatureUrlFunction} [url]
@@ -191,7 +200,7 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {ol.LoadingStrategy}
* @type {module:ol/source/Vector~LoadingStrategy}
*/
this.strategy_ = options.strategy !== undefined ? options.strategy : allStrategy;

View File

@@ -1,31 +0,0 @@
/**
* @module ol/typedefs
*/
//FIXME Remove when reworking typedefs, export typedefs as variables instead
const ol = {};
/**
* File for all typedefs used by the compiler, and referenced by JSDoc.
*
* These look like vars (or var properties), but in fact are simply identifiers
* for the Closure compiler. Originally they were included in the appropriate
* namespace file, but with the move away from Closure namespaces and towards
* self-contained standard modules are now all in this file.
* Unlike the other type definitions - enums and constructor functions - they
* are not code and so are not imported or exported. They are only referred to
* in type-defining comments used by the Closure compiler, and so should not
* appear in module code.
*
* They are now all in the `ol` namespace.
*/
/**
* A function that takes an {@link module:ol/extent~Extent} and a resolution as arguments, and
* returns an array of {@link module:ol/extent~Extent} with the extents to load. Usually this
* is one of the standard {@link ol.loadingstrategy} strategies.
*
* @typedef {function(module:ol/extent~Extent, number): Array.<module:ol/extent~Extent>}
*/
ol.LoadingStrategy;