ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove api annotations from typedefs

Browse Source
This commit is contained in:
Andreas Hocevar
2016-06-03 09:29:04 +02:00
parent eddd006fcf
commit ca07de422c
1 changed files with 0 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/ol/typedefs.js
View File

@@ -32,7 +32,6 @@ goog.provide('ol.style.AtlasBlock');
/**
* @typedef {string|Array.<string>|ol.Attribution|Array.<ol.Attribution>}
* @api
*/
ol.AttributionLike;
@@ -54,7 +53,6 @@ ol.CanvasFillState;
*
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
* @api
*/
ol.CanvasFunctionType;
@@ -90,7 +88,6 @@ ol.CenterConstraintType;
* alpha should be a float in the range 0..1 inclusive. If no alpha value is
* given then `1` will be used.
* @typedef {Array.<number>}
* @api
*/
ol.Color;
@@ -100,7 +97,6 @@ ol.Color;
* Represents a color, pattern, or gradient.
*
* @typedef {string|CanvasPattern|CanvasGradient}
* @api
*/
ol.ColorLike;
@@ -108,7 +104,6 @@ ol.ColorLike;
/**
* An array of numbers representing an xy coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate
* @api stable
*/
ol.Coordinate;
@@ -118,7 +113,6 @@ ol.Coordinate;
* `{string}`.
*
* @typedef {function((ol.Coordinate|undefined)): string}
* @api stable
*/
ol.CoordinateFormatType;
@@ -126,7 +120,6 @@ ol.CoordinateFormatType;
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Extent;
@@ -142,7 +135,6 @@ ol.Extent;
*
* The function is responsible for loading the features and adding them to the
* source.
* @api
* @typedef {function(this:ol.source.Vector, ol.Extent, number,
* ol.proj.Projection)}
*/
@@ -156,7 +148,6 @@ ol.FeatureLoader;
*
* @typedef {function(this: ol.Feature, number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api stable
*/
ol.FeatureStyleFunction;
@@ -169,7 +160,6 @@ ol.FeatureStyleFunction;
* a `{number}` representing the resolution (map units per pixel) and an
* {@link ol.proj.Projection} for the projection as arguments and returns a
* `{string}` representing the URL.
* @api
* @typedef {function(ol.Extent, number, ol.proj.Projection) : string}
*/
ol.FeatureUrlFunction;
@@ -201,7 +191,6 @@ ol.ImageCanvasLoader;
* image element would be set to a data URI when the content is loaded.
*
* @typedef {function(ol.Image, string)}
* @api
*/
ol.ImageLoadFunctionType;
@@ -238,7 +227,6 @@ ol.LayerState;
* One of `all`, `bbox`, `tile`.
*
* @typedef {function(ol.Extent, number): Array.<ol.Extent>}
* @api
*/
ol.LoadingStrategy;
@@ -269,7 +257,6 @@ ol.MapOptionsInternal;
* An array with two elements, representing a pixel. The first element is the
* x-coordinate, the second the y-coordinate of the pixel.
* @typedef {Array.<number>}
* @api stable
*/
ol.Pixel;
@@ -286,7 +273,6 @@ ol.PostRenderFunction;
* second argument. Return `true` to keep this function for the next frame,
* `false` to remove it.
* @typedef {function(ol.Map, ?olx.FrameState): boolean}
* @api
*/
ol.PreRenderFunction;
@@ -327,7 +313,6 @@ ol.RotationConstraintType;
/**
* An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>}
* @api stable
*/
ol.Size;
@@ -399,7 +384,6 @@ ol.SourceUrlTileOptions;
* An array of three numbers representing the location of a tile in a tile
* grid. The order is `z`, `x`, and `y`. `z` is the zoom level.
* @typedef {Array.<number>} ol.TileCoord
* @api
*/
ol.TileCoord;
@@ -409,7 +393,6 @@ ol.TileCoord;
* the url as arguments.
*
* @typedef {function(ol.Tile, string)}
* @api
*/
ol.TileLoadFunctionType;
@@ -444,7 +427,6 @@ ol.TileReplayState;
*
* @typedef {function(ol.TileCoord, number,
* ol.proj.Projection): (string|undefined)}
* @api
*/
ol.TileUrlFunctionType;
@@ -456,7 +438,6 @@ ol.TileUrlFunctionType;
* returns the output array.
*
* @typedef {function(Array.<number>, Array.<number>=, number=): Array.<number>}
* @api stable
*/
ol.TransformFunction;
@@ -478,7 +459,6 @@ ol.WebglTextureCacheEntry;
* Number of features; bounds/extent.
* @typedef {{numberOfFeatures: number,
* bounds: ol.Extent}}
* @api stable
*/
ol.WFSFeatureCollectionMetadata;
@@ -489,7 +469,6 @@ ol.WFSFeatureCollectionMetadata;
* totalInserted: number,
* totalUpdated: number,
* insertIds: Array.<string>}}
* @api stable
*/
ol.WFSTransactionResponse;
@@ -526,7 +505,6 @@ ol.XmlSerializer;
* `{boolean}`. If the condition is met, true should be returned.
*
* @typedef {function(ol.MapBrowserEvent): boolean}
* @api stable
*/
ol.events.ConditionType;
@@ -550,7 +528,6 @@ ol.events.EventTargetLike;
* listener: ol.events.ListenerFunctionType,
* target: (EventTarget|ol.events.EventTarget),
* type: string}}
* @api
*/
ol.events.Key;
@@ -560,7 +537,6 @@ ol.events.Key;
* When the function returns `false`, event propagation will stop.
*
* @typedef {function(ol.events.Event)|function(ol.events.Event): boolean}
* @api
*/
ol.events.ListenerFunctionType;
@@ -570,7 +546,6 @@ ol.events.ListenerFunctionType;
* {@link ol.Pixel}s and returns a `{boolean}`. If the condition is met,
* true should be returned.
* @typedef {function(ol.MapBrowserEvent, ol.Pixel, ol.Pixel):boolean}
* @api
*/
ol.interaction.DragBoxEndConditionType;
@@ -583,7 +558,6 @@ ol.interaction.DragBoxEndConditionType;
* @typedef {function(!(ol.Coordinate|Array.<ol.Coordinate>|
* Array.<Array.<ol.Coordinate>>), ol.geom.SimpleGeometry=):
* ol.geom.SimpleGeometry}
* @api
*/
ol.interaction.DrawGeometryFunctionType;
@@ -604,7 +578,6 @@ ol.interaction.SegmentDataType;
* or `false` otherwise.
* @typedef {function((ol.Feature|ol.render.Feature), ol.layer.Layer):
* boolean}
* @api
*/
ol.interaction.SelectFilterFunction;
@@ -632,7 +605,6 @@ ol.interaction.SnapSegmentDataType;
* A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
* @api stable
*/
ol.proj.ProjectionLike;
@@ -651,7 +623,6 @@ ol.proj.ProjectionLike;
*
* @typedef {function((Array.<ol.raster.Pixel>|Array.<ImageData>), Object):
* (Array.<ol.raster.Pixel>|Array.<ImageData>)}
* @api
*/
ol.raster.Operation;
@@ -659,7 +630,6 @@ ol.raster.Operation;
/**
* An array of numbers representing pixel values.
* @typedef {Array.<number>} ol.raster.Pixel
* @api
*/
ol.raster.Pixel;
@@ -713,7 +683,6 @@ ol.style.ImageOptions;
*
* @typedef {function((ol.Feature|ol.render.Feature)):
* (ol.geom.Geometry|ol.render.Feature|undefined)}
* @api
*/
ol.style.GeometryFunction;
@@ -739,6 +708,5 @@ ol.style.RegularShapeRenderOptions;
*
* @typedef {function((ol.Feature|ol.render.Feature), number):
* (ol.style.Style|Array.<ol.style.Style>)}
* @api
*/
ol.style.StyleFunction;