Merge pull request #930 from elemoine/externs

Use @exportSymbol instead of @exportClass|Function
This commit is contained in:
Éric Lemoine
2013-12-12 23:40:44 -08:00
128 changed files with 272 additions and 282 deletions
+4 -4
View File
@@ -1,4 +1,4 @@
@exportFunction ol.animation.bounce ol.animation.BounceOptions ol.PreRenderFunction
@exportFunction ol.animation.pan ol.animation.PanOptions ol.PreRenderFunction
@exportFunction ol.animation.rotate ol.animation.RotateOptions ol.PreRenderFunction
@exportFunction ol.animation.zoom ol.animation.ZoomOptions ol.PreRenderFunction
@exportSymbol ol.animation.bounce ol.animation.bounce
@exportSymbol ol.animation.pan ol.animation.pan
@exportSymbol ol.animation.rotate ol.animation.rotate
@exportSymbol ol.animation.zoom ol.animation.zoom
+4 -4
View File
@@ -8,7 +8,7 @@ goog.require('ol.easing');
/**
* @param {ol.animation.BounceOptions} options Bounce options.
* @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -43,7 +43,7 @@ ol.animation.bounce = function(options) {
/**
* @param {ol.animation.PanOptions} options Pan options.
* @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -82,7 +82,7 @@ ol.animation.pan = function(options) {
/**
* @param {ol.animation.RotateOptions} options Rotate options.
* @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -119,7 +119,7 @@ ol.animation.rotate = function(options) {
/**
* @param {ol.animation.ZoomOptions} options Zoom options.
* @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.Attribution ol.AttributionOptions
@exportSymbol ol.Attribution
+1 -1
View File
@@ -20,7 +20,7 @@ goog.require('ol.TileRange');
* ..
*
* @constructor
* @param {ol.AttributionOptions} options Attribution options.
* @param {olx.AttributionOptions} options Attribution options.
* @todo stability experimental
*/
ol.Attribution = function(options) {
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.control.Attribution ol.control.AttributionOptions
@exportSymbol ol.control.Attribution
@exportProperty ol.control.Attribution.prototype.setMap
+1 -1
View File
@@ -21,7 +21,7 @@ goog.require('ol.css');
* be changed by using a css selector for `.ol-attribution`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
*/
ol.control.Attribution = function(opt_options) {
+1 -1
View File
@@ -1,3 +1,3 @@
@exportClass ol.control.Control ol.control.ControlOptions
@exportSymbol ol.control.Control
@exportProperty ol.control.Control.prototype.getMap
@exportProperty ol.control.Control.prototype.setMap
+1 -1
View File
@@ -15,7 +15,7 @@ goog.require('ol.Object');
* @constructor
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {ol.control.ControlOptions} options Control options.
* @param {olx.control.ControlOptions} options Control options.
* @todo stability experimental
*/
ol.control.Control = function(options) {
+1 -1
View File
@@ -1 +1 @@
@exportFunction ol.control.defaults ol.control.DefaultsOptions ol.Collection
@exportSymbol ol.control.defaults ol.control.defaults
+1 -1
View File
@@ -7,7 +7,7 @@ goog.require('ol.control.Zoom');
/**
* @param {ol.control.DefaultsOptions=} opt_options Defaults options.
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo stability experimental
*/
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.control.FullScreen ol.control.FullScreenOptions
@exportSymbol ol.control.FullScreen
+1 -1
View File
@@ -22,7 +22,7 @@ goog.require('ol.css');
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.FullScreenOptions=} opt_options Options.
* @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.FullScreen = function(opt_options) {
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.control.Logo ol.control.LogoOptions
@exportSymbol ol.control.Logo
@exportProperty ol.control.Logo.prototype.setMap
+1 -1
View File
@@ -17,7 +17,7 @@ goog.require('ol.css');
* be styled by using a css selector for `.ol-logo`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.
* @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
*/
ol.control.Logo = function(opt_options) {
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.control.MousePosition ol.control.MousePositionOptions
@exportSymbol ol.control.MousePosition
@exportProperty ol.control.MousePosition.prototype.setMap
+2 -1
View File
@@ -36,7 +36,8 @@ ol.control.MousePositionProperty = {
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.
* @param {olx.control.MousePositionOptions=} opt_options Mouse position
* options.
* @todo stability experimental
* @todo observable projection {ol.proj.Projection} the projection to report
* mouse position in
+1 -1
View File
@@ -1,4 +1,4 @@
@exportClass ol.control.ScaleLine ol.control.ScaleLineOptions
@exportSymbol ol.control.ScaleLine
@exportProperty ol.control.ScaleLine.prototype.setMap
@exportSymbol ol.control.ScaleLineUnits
+1 -1
View File
@@ -49,7 +49,7 @@ ol.control.ScaleLineUnits = {
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo stability experimental
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.control.Zoom ol.control.ZoomOptions
@exportSymbol ol.control.Zoom
@exportProperty ol.control.Zoom.prototype.setMap
+1 -1
View File
@@ -19,7 +19,7 @@ goog.require('ol.easing');
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
*/
ol.control.Zoom = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.control.ZoomSlider ol.control.ZoomSliderOptions
@exportSymbol ol.control.ZoomSlider
+1 -1
View File
@@ -37,7 +37,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
*/
ol.control.ZoomSlider = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.control.ZoomToExtent ol.control.ZoomToExtentOptions
@exportSymbol ol.control.ZoomToExtent
+1 -1
View File
@@ -17,7 +17,7 @@ goog.require('ol.css');
* css selector `.ol-zoom-extent`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.ZoomToExtent = function(opt_options) {
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.DeviceOrientation ol.DeviceOrientationOptions
@exportSymbol ol.DeviceOrientation
@exportSymbol ol.DeviceOrientation.SUPPORTED ol.DeviceOrientation.SUPPORTED
+1 -1
View File
@@ -67,7 +67,7 @@ ol.DeviceOrientationProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.DeviceOrientationOptions=} opt_options Options.
* @param {olx.DeviceOrientationOptions=} opt_options Options.
* @todo stability experimental
* @todo observable alpha {number} readonly the euler angle in radians of the
* device from the standard X axis
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.Geolocation ol.GeolocationOptions
@exportSymbol ol.Geolocation
@exportSymbol ol.Geolocation.SUPPORTED ol.Geolocation.SUPPORTED
+1 -1
View File
@@ -45,7 +45,7 @@ ol.GeolocationProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.GeolocationOptions=} opt_options Options.
* @param {olx.GeolocationOptions=} opt_options Options.
* @todo stability experimental
* @todo observable accuracy {number} readonly the accuracy of the position
* measurement
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.DoubleClickZoom ol.interaction.DoubleClickZoomOptions
@exportSymbol ol.interaction.DoubleClickZoom
@@ -14,7 +14,7 @@ goog.require('ol.interaction.Interaction');
*
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options.
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DoubleClickZoom = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.DragPan ol.interaction.DragPanOptions
@exportSymbol ol.interaction.DragPan
+1 -1
View File
@@ -18,7 +18,7 @@ goog.require('ol.interaction.Drag');
* Allows the user to pan the map by clickng and dragging.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragPanOptions=} opt_options Options.
* @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragPan = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.DragRotate ol.interaction.DragRotateOptions
@exportSymbol ol.interaction.DragRotate
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.DragRotateAndZoom ol.interaction.DragRotateAndZoomOptions
@exportSymbol ol.interaction.DragRotateAndZoom
@@ -26,7 +26,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
* This interaction is not included in the default interactions.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragRotateAndZoom = function(opt_options) {
+1 -1
View File
@@ -21,7 +21,7 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
* it to when the alt and shift keys are held down.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragRotateOptions=} opt_options Options.
* @param {olx.interaction.DragRotateOptions=} opt_options Options.
*/
ol.interaction.DragRotate = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.DragZoom ol.interaction.DragZoomOptions
@exportSymbol ol.interaction.DragZoom
+1 -1
View File
@@ -34,7 +34,7 @@ ol.SHIFT_DRAG_ZOOM_HYSTERESIS_PIXELS_SQUARED =
* it to when the shift key is held down.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragZoomOptions=} opt_options Options.
* @param {olx.interaction.DragZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragZoom = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.Draw ol.interaction.DrawOptions
@exportSymbol ol.interaction.Draw
+1 -1
View File
@@ -23,7 +23,7 @@ goog.require('ol.source.Vector');
/**
* Interaction that allows drawing geometries.
* @param {ol.interaction.DrawOptions} options Options.
* @param {olx.interaction.DrawOptions} options Options.
* @constructor
* @extends {ol.interaction.Interaction}
*/
@@ -1 +1 @@
@exportFunction ol.interaction.defaults ol.interaction.DefaultsOptions ol.Collection
@exportSymbol ol.interaction.defaults ol.interaction.defaults
+1 -1
View File
@@ -23,7 +23,7 @@ goog.require('ol.interaction.TouchZoom');
* {@link ol.interaction} instances and insert them into an
* {@link ol.Collection} in the order you want before creating your ol.Map
* instance.
* @param {ol.interaction.DefaultsOptions=} opt_options Defaults options.
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option.
* @todo stability experimental
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.KeyboardPan ol.interaction.KeyboardPanOptions
@exportSymbol ol.interaction.KeyboardPan
+1 -1
View File
@@ -24,7 +24,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
* Allows the user to pan the map using keyboard arrows.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.KeyboardPanOptions=} opt_options Options.
* @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.KeyboardPan = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.KeyboardZoom ol.interaction.KeyboardZoomOptions
@exportSymbol ol.interaction.KeyboardZoom
@@ -13,7 +13,7 @@ goog.require('ol.interaction.Interaction');
/**
* Allows the user to zoom the map using keyboard + and -.
* @constructor
* @param {ol.interaction.KeyboardZoomOptions=} opt_options Options.
* @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction}
* @todo stability experimental
*/
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.Modify ol.interaction.ModifyOptions
@exportSymbol ol.interaction.Modify
+1 -1
View File
@@ -38,7 +38,7 @@ ol.interaction.SegmentDataType;
/**
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.ModifyOptions=} opt_options Options.
* @param {olx.interaction.ModifyOptions=} opt_options Options.
*/
ol.interaction.Modify = function(opt_options) {
goog.base(this);
@@ -27,7 +27,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
* Allows the user to zoom the map by scrolling the mouse wheel.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options.
* @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.MouseWheelZoom = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.Select ol.interaction.SelectOptions
@exportSymbol ol.interaction.Select
+1 -1
View File
@@ -15,7 +15,7 @@ goog.require('ol.layer.Vector');
* Allows the user to select features on the map.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.SelectOptions=} opt_options Options.
* @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.Select = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.TouchPan ol.interaction.TouchPanOptions
@exportSymbol ol.interaction.TouchPan
+1 -1
View File
@@ -15,7 +15,7 @@ goog.require('ol.interaction.Touch');
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchPanOptions=} opt_options Options.
* @param {olx.interaction.TouchPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchPan = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.interaction.TouchRotate ol.interaction.TouchRotateOptions
@exportSymbol ol.interaction.TouchRotate
+1 -1
View File
@@ -21,7 +21,7 @@ ol.interaction.TOUCHROTATE_ANIMATION_DURATION = 250;
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchRotateOptions=} opt_options Options.
* @param {olx.interaction.TouchRotateOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchRotate = function(opt_options) {
+1 -1
View File
@@ -15,7 +15,7 @@ goog.require('ol.interaction.Touch');
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchZoomOptions=} opt_options Options.
* @param {olx.interaction.TouchZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchZoom = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.layer.Image ol.layer.LayerOptions
@exportSymbol ol.layer.Image
+1 -1
View File
@@ -8,7 +8,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.LayerOptions} options Layer options.
* @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
*/
ol.layer.Image = function(options) {
+2 -2
View File
@@ -12,7 +12,7 @@ goog.require('ol.source.Source');
/**
* @constructor
* @extends {ol.layer.Base}
* @param {ol.layer.LayerOptions} options Layer options.
* @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
* @todo observable brightness {number} the brightness of the layer
* @todo observable contrast {number} the contrast of the layer
@@ -25,7 +25,7 @@ goog.require('ol.source.Source');
*/
ol.layer.Layer = function(options) {
var baseOptions = /** @type {ol.layer.LayerOptions} */
var baseOptions = /** @type {olx.layer.LayerOptions} */
(goog.object.clone(options));
delete baseOptions.source;
+1 -1
View File
@@ -43,7 +43,7 @@ ol.layer.LayerState;
/**
* @constructor
* @extends {ol.Object}
* @param {ol.layer.BaseOptions} options Layer options.
* @param {olx.layer.BaseOptions} options Layer options.
*/
ol.layer.Base = function(options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.layer.Group ol.layer.GroupOptions
@exportSymbol ol.layer.Group
+2 -2
View File
@@ -26,7 +26,7 @@ ol.layer.GroupProperty = {
/**
* @constructor
* @extends {ol.layer.Base}
* @param {ol.layer.GroupOptions=} opt_options Layer options.
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo stability experimental
* @todo observable layers {ol.Collection} collection of layers that are part
* of this group
@@ -34,7 +34,7 @@ ol.layer.GroupProperty = {
ol.layer.Group = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};
var baseOptions = /** @type {ol.layer.GroupOptions} */
var baseOptions = /** @type {olx.layer.GroupOptions} */
(goog.object.clone(options));
delete baseOptions.layers;
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.layer.Tile ol.layer.TileOptions
@exportSymbol ol.layer.Tile
+1 -1
View File
@@ -16,7 +16,7 @@ ol.layer.TileProperty = {
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.TileOptions} options Tile layer options.
* @param {olx.layer.TileOptions} options Tile layer options.
* @todo stability experimental
* @todo observable preload {number} the level to preload tiles up to
*/
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.layer.Vector ol.layer.VectorLayerOptions
@exportSymbol ol.layer.Vector
+3 -3
View File
@@ -15,12 +15,12 @@ goog.require('ol.style.Style');
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.VectorLayerOptions} options Vector layer options.
* @param {olx.layer.VectorLayerOptions} options Vector layer options.
* @todo stability experimental
*/
ol.layer.Vector = function(options) {
var baseOptions = /** @type {ol.layer.VectorLayerOptions} */
var baseOptions = /** @type {olx.layer.VectorLayerOptions} */
(goog.object.clone(options));
/**
@@ -45,7 +45,7 @@ ol.layer.Vector = function(options) {
*/
this.temporary_ = false;
goog.base(this, /** @type {ol.layer.LayerOptions} */ (baseOptions));
goog.base(this, /** @type {olx.layer.LayerOptions} */ (baseOptions));
};
goog.inherits(ol.layer.Vector, ol.layer.Layer);
+1 -1
View File
@@ -1,4 +1,4 @@
@exportClass ol.Map ol.MapOptions
@exportSymbol ol.Map
@exportProperty ol.Map.prototype.addControl
@exportProperty ol.Map.prototype.addInteraction
@exportProperty ol.Map.prototype.addLayer
+4 -4
View File
@@ -141,7 +141,7 @@ ol.MapProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.MapOptions} options Map options.
* @param {olx.MapOptions} options Map options.
* @todo stability experimental
* @todo observable layergroup {ol.layer.LayerGroup} a layer group containing
* the layers in this map.
@@ -563,7 +563,7 @@ ol.Map.prototype.getOverlays = function() {
/**
* Get feature information for a pixel on the map.
*
* @param {ol.GetFeatureInfoOptions} options Options.
* @param {olx.GetFeatureInfoOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatureInfo = function(options) {
@@ -577,7 +577,7 @@ ol.Map.prototype.getFeatureInfo = function(options) {
/**
* Get features for a pixel on the map.
*
* @param {ol.GetFeaturesOptions} options Options.
* @param {olx.GetFeaturesOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatures = function(options) {
@@ -1241,7 +1241,7 @@ ol.MapOptionsInternal;
/**
* @param {ol.MapOptions} options Map options.
* @param {olx.MapOptions} options Map options.
* @return {ol.MapOptionsInternal} Internal map options.
*/
ol.Map.createOptionsInternal = function(options) {
+1 -1
View File
@@ -1,4 +1,4 @@
@exportClass ol.Overlay ol.OverlayOptions
@exportSymbol ol.Overlay
@exportSymbol ol.OverlayPositioning
@exportProperty ol.OverlayPositioning.BOTTOM_LEFT
+1 -1
View File
@@ -55,7 +55,7 @@ ol.OverlayPositioning = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.OverlayOptions} options Overlay options.
* @param {olx.OverlayOptions} options Overlay options.
* @todo stability experimental
* @todo observable element {Element} the Element containing the overlay
* @todo observable map {ol.Map} the map that the overlay is part of
+3 -3
View File
@@ -21,12 +21,12 @@ goog.require('ol.parser.XML');
* @implements {ol.parser.DomFeatureParser}
* @implements {ol.parser.StringFeatureParser}
* @implements {ol.parser.ObjectFeatureParser}
* @param {ol.parser.GPXOptions=} opt_options Optional configuration object.
* @param {olx.parser.GPXOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.GPX = function(opt_options) {
var options = /** @type {ol.parser.GPXOptions} */
var options = /** @type {olx.parser.GPXOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;
@@ -269,7 +269,7 @@ ol.parser.GPX.prototype.readFeaturesFromObject = function(obj) {
/**
* @param {ol.parser.GPXWriteOptions} obj Object structure to write out
* @param {olx.parser.GPXWriteOptions} obj Object structure to write out
* as GPX.
* @return {string} An string representing the GPX document.
*/
+2 -2
View File
@@ -40,12 +40,12 @@ goog.require('ol.style.Stroke');
* @implements {ol.parser.StringFeatureParser}
* @implements {ol.parser.AsyncObjectFeatureParser}
* @implements {ol.parser.AsyncStringFeatureParser}
* @param {ol.parser.KMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.KMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.KML = function(opt_options) {
var options = /** @type {ol.parser.KMLOptions} */
var options = /** @type {olx.parser.KMLOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;
+1 -1
View File
@@ -649,6 +649,6 @@ ol.parser.ogc.Filter_v1.prototype.setSrsName = function(srsName) {
this.srsName = srsName;
if (goog.isDefAndNotNull(this.gmlParser_)) {
this.gmlParser_.applyWriteOptions({},
/** @type {ol.parser.GMLWriteOptions} */ ({srsName: srsName}));
/** @type {olx.parser.GMLWriteOptions} */ ({srsName: srsName}));
}
};
+4 -4
View File
@@ -22,12 +22,12 @@ goog.require('ol.proj');
/**
* @constructor
* @implements {ol.parser.StringFeatureParser}
* @param {ol.parser.GMLOptions=} opt_options
* @param {olx.parser.GMLOptions=} opt_options
* Optional configuration object.
* @extends {ol.parser.XML}
*/
ol.parser.ogc.GML = function(opt_options) {
var options = /** @type {ol.parser.GMLOptions} */
var options = /** @type {olx.parser.GMLOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;
@@ -491,7 +491,7 @@ ol.parser.ogc.GML.prototype.writeGeometry = function(geometry) {
/**
* @param {string|Document|Element|Object} data Data to read.
* @param {ol.parser.GMLReadOptions=} opt_options Read options.
* @param {olx.parser.GMLReadOptions=} opt_options Read options.
* @return {ol.parser.ReadFeaturesResult} An object representing the document.
*/
ol.parser.ogc.GML.prototype.read = function(data, opt_options) {
@@ -630,7 +630,7 @@ ol.parser.ogc.GML.prototype.readFeaturesFromString = function(str) {
* Applies the writeOptions passed into the write function.
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* GML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
*/
ol.parser.ogc.GML.prototype.applyWriteOptions = function(obj, opt_options) {
// srsName handling: opt_options -> this.writeOptions -> obj.metadata
+2 -2
View File
@@ -11,7 +11,7 @@ goog.require('ol.parser.ogc.GML');
* version 2.1.2
*
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
@@ -127,7 +127,7 @@ goog.inherits(ol.parser.ogc.GML_v2, ol.parser.ogc.GML);
/**
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* GML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} A string representing the GML document.
* @todo stability experimental
*/
+2 -2
View File
@@ -13,7 +13,7 @@ goog.require('ol.parser.ogc.GML');
* version 3.1.1
*
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
@@ -425,7 +425,7 @@ goog.inherits(ol.parser.ogc.GML_v3, ol.parser.ogc.GML);
/**
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* XML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} An string representing the XML document.
* @todo stability experimental
*/
+4 -4
View File
@@ -89,7 +89,7 @@ ol.parser.ogc.SLD_v1 = function() {
delete config.fill;
config.zIndex = this.featureTypeCounter;
rule.symbolizers.push(
new ol.style.Text(/** @type {ol.style.TextOptions} */(config))
new ol.style.Text(/** @type {olx.style.TextOptions} */(config))
);
},
'Label': function(node, symbolizer) {
@@ -197,7 +197,7 @@ ol.parser.ogc.SLD_v1 = function() {
if (goog.isDef(config.externalGraphic)) {
config.width = config.height = config.size;
symbolizer = new ol.style.Icon(
/** @type {ol.style.IconOptions} */(config));
/** @type {olx.style.IconOptions} */(config));
} else {
symbolizer = new ol.style.Shape(config);
}
@@ -689,7 +689,7 @@ ol.parser.ogc.SLD_v1.prototype.getScaleDenominatorFromResolution_ =
/**
* @param {string|Document|Element} data Data to read.
* @param {ol.parser.SLDReadOptions=} opt_options Read options.
* @param {olx.parser.SLDReadOptions=} opt_options Read options.
* @return {Object} An object representing the document.
*/
ol.parser.ogc.SLD_v1.prototype.read = function(data, opt_options) {
@@ -713,7 +713,7 @@ ol.parser.ogc.SLD_v1.prototype.read = function(data, opt_options) {
/**
* @param {Object} style The style to write out.
* @param {ol.parser.SLDWriteOptions=} opt_options Write options.
* @param {olx.parser.SLDWriteOptions=} opt_options Write options.
* @return {string} The serialized SLD.
*/
ol.parser.ogc.SLD_v1.prototype.write = function(style, opt_options) {
+8 -8
View File
@@ -28,9 +28,9 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
this.writers = {};
this.writers[this.defaultNamespaceURI] = {
/**
* @param {ol.parser.WFSWriteGetFeatureOptions} options Options.
* @param {olx.parser.WFSWriteGetFeatureOptions} options Options.
* @return {{node: Node,
* options: ol.parser.WFSWriteGetFeatureOptions}} Object.
* options: olx.parser.WFSWriteGetFeatureOptions}} Object.
* @this {ol.parser.XML}
*/
'GetFeature': function(options) {
@@ -64,7 +64,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
* @param {{inserts: Array.<ol.Feature>,
* updates: Array.<ol.Feature>,
* deletes: Array.<ol.Feature>,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -120,7 +120,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -140,7 +140,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -213,7 +213,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -338,7 +338,7 @@ ol.parser.ogc.WFS_v1.prototype.read = function(data) {
/**
* @param {ol.parser.WFSWriteGetFeatureOptions} options Options.
* @param {olx.parser.WFSWriteGetFeatureOptions} options Options.
* @return {string} A serialized WFS GetFeature query.
*/
ol.parser.ogc.WFS_v1.prototype.writeGetFeature = function(options) {
@@ -352,7 +352,7 @@ ol.parser.ogc.WFS_v1.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} inserts The features to insert.
* @param {Array.<ol.Feature>} updates The features to update.
* @param {Array.<ol.Feature>} deletes The features to delete.
* @param {ol.parser.WFSWriteTransactionOptions} options Write options.
* @param {olx.parser.WFSWriteTransactionOptions} options Write options.
* @return {string} A serialized WFS transaction.
*/
ol.parser.ogc.WFS_v1.prototype.writeTransaction =
+1 -1
View File
@@ -1,4 +1,4 @@
@exportClass ol.proj.Projection ol.ProjectionOptions
@exportSymbol ol.proj.Projection
@exportProperty ol.proj.Projection.prototype.getCode
@exportProperty ol.proj.Projection.prototype.getExtent
+6 -6
View File
@@ -58,7 +58,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
/**
* @constructor
* @param {ol.ProjectionOptions} options Projection options.
* @param {olx.ProjectionOptions} options Projection options.
* @todo stability experimental
*/
ol.proj.Projection = function(options) {
@@ -198,14 +198,14 @@ ol.proj.Projection.prototype.setDefaultTileGrid = function(tileGrid) {
* @constructor
* @extends {ol.proj.Projection}
* @param {Proj4js.Proj} proj4jsProj Proj4js projection.
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @private
*/
ol.Proj4jsProjection_ = function(proj4jsProj, options) {
var units = /** @type {ol.proj.Units} */ (proj4jsProj.units);
var config = /** @type {ol.ProjectionOptions} */ ({
var config = /** @type {olx.ProjectionOptions} */ ({
units: units,
axisOrientation: proj4jsProj.axis
});
@@ -491,7 +491,7 @@ ol.proj.get = function(projectionLike) {
/**
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @private
* @return {ol.Proj4jsProjection_} Proj4js projection.
*/
@@ -504,7 +504,7 @@ ol.proj.getProj4jsProjectionFromCode_ = function(options) {
var srsCode = proj4jsProj.srsCode;
proj4jsProjection = proj4jsProjections[srsCode];
if (!goog.isDef(proj4jsProjection)) {
var config = /** @type {ol.Proj4jsProjectionOptions} */
var config = /** @type {olx.Proj4jsProjectionOptions} */
(goog.object.clone(options));
config.code = srsCode;
proj4jsProjection = new ol.Proj4jsProjection_(proj4jsProj, config);
@@ -709,7 +709,7 @@ ol.proj.transformWithProjections =
/**
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @return {ol.proj.Projection} Proj4js projection.
* @todo stability experimental
*/
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.source.BingMaps ol.source.BingMapsOptions
@exportSymbol ol.source.BingMaps
@exportProperty ol.source.BingMaps.TOS_ATTRIBUTION
+1 -1
View File
@@ -18,7 +18,7 @@ goog.require('ol.tilegrid.XYZ');
/**
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.BingMapsOptions} options Bing Maps options.
* @param {olx.source.BingMapsOptions} options Bing Maps options.
* @todo stability experimental
*/
ol.source.BingMaps = function(options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.source.TileDebug ol.source.TileDebugOptions
@exportSymbol ol.source.TileDebug
+1 -1
View File
@@ -85,7 +85,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
/**
* @constructor
* @extends {ol.source.Tile}
* @param {ol.source.TileDebugOptions} options Debug tile options.
* @param {olx.source.TileDebugOptions} options Debug tile options.
* @todo stability experimental
*/
ol.source.TileDebug = function(options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.source.ImageStatic ol.source.ImageStaticOptions
@exportSymbol ol.source.ImageStatic
+1 -1
View File
@@ -11,7 +11,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.source.Image}
* @param {ol.source.ImageStaticOptions} options Options.
* @param {olx.source.ImageStaticOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageStatic = function(options) {
+1 -1
View File
@@ -1,3 +1,3 @@
@exportClass ol.source.ImageWMS ol.source.ImageWMSOptions
@exportSymbol ol.source.ImageWMS
@exportProperty ol.source.ImageWMS.prototype.getParams
@exportProperty ol.source.ImageWMS.prototype.updateParams
+3 -3
View File
@@ -15,7 +15,7 @@ goog.require('ol.source.wms');
* @constructor
* @extends {ol.source.Image}
* @implements {ol.source.FeatureInfoSource}
* @param {ol.source.ImageWMSOptions} options Options.
* @param {olx.source.ImageWMSOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageWMS = function(options) {
@@ -42,11 +42,11 @@ ol.source.ImageWMS = function(options) {
/**
* @private
* @type {ol.source.WMSGetFeatureInfoOptions}
* @type {olx.source.WMSGetFeatureInfoOptions}
*/
this.getFeatureInfoOptions_ = goog.isDef(options.getFeatureInfoOptions) ?
options.getFeatureInfoOptions :
/** @type {ol.source.WMSGetFeatureInfoOptions} */ ({});
/** @type {olx.source.WMSGetFeatureInfoOptions} */ ({});
/**
* @private
+1 -1
View File
@@ -11,7 +11,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.source.Image}
* @param {ol.source.MapGuideOptions} options Options.
* @param {olx.source.MapGuideOptions} options Options.
*/
ol.source.MapGuide = function(options) {
+2 -2
View File
@@ -10,7 +10,7 @@ goog.require('ol.source.XYZ');
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOSM = function(opt_options) {
@@ -43,7 +43,7 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ);
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOpenAerial = function(opt_options) {
+1 -1
View File
@@ -8,7 +8,7 @@ goog.require('ol.source.XYZ');
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.OSMOptions=} opt_options Open Street Map options.
* @param {olx.source.OSMOptions=} opt_options Open Street Map options.
* @todo stability experimental
*/
ol.source.OSM = function(opt_options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.source.Stamen ol.source.StamenOptions
@exportSymbol ol.source.Stamen
+1 -1
View File
@@ -80,7 +80,7 @@ ol.source.StamenProviderConfig = {
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.StamenOptions} options Stamen options.
* @param {olx.source.StamenOptions} options Stamen options.
* @todo stability experimental
*/
ol.source.Stamen = function(options) {
+1 -1
View File
@@ -1 +1 @@
@exportClass ol.source.TileJSON ol.source.TileJSONOptions
@exportSymbol ol.source.TileJSON
+1 -1
View File
@@ -40,7 +40,7 @@ goog.exportSymbol('grid', grid);
/**
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.TileJSONOptions} options TileJSON options.
* @param {olx.source.TileJSONOptions} options TileJSON options.
* @todo stability experimental
*/
ol.source.TileJSON = function(options) {
+1 -1
View File
@@ -1,3 +1,3 @@
@exportClass ol.source.TileWMS ol.source.TileWMSOptions
@exportSymbol ol.source.TileWMS
@exportProperty ol.source.TileWMS.prototype.getParams
@exportProperty ol.source.TileWMS.prototype.updateParams
+3 -3
View File
@@ -19,7 +19,7 @@ goog.require('ol.source.wms');
* @constructor
* @extends {ol.source.TileImage}
* @implements {ol.source.FeatureInfoSource}
* @param {ol.source.TileWMSOptions} options Tile WMS options.
* @param {olx.source.TileWMSOptions} options Tile WMS options.
* @todo stability experimental
*/
ol.source.TileWMS = function(options) {
@@ -107,11 +107,11 @@ ol.source.TileWMS = function(options) {
/**
* @private
* @type {ol.source.WMSGetFeatureInfoOptions}
* @type {olx.source.WMSGetFeatureInfoOptions}
*/
this.getFeatureInfoOptions_ = goog.isDef(options.getFeatureInfoOptions) ?
options.getFeatureInfoOptions :
/** @type {ol.source.WMSGetFeatureInfoOptions} */ ({});
/** @type {olx.source.WMSGetFeatureInfoOptions} */ ({});
};
goog.inherits(ol.source.TileWMS, ol.source.TileImage);
+1 -1
View File
@@ -1,2 +1,2 @@
@exportClass ol.source.Vector ol.source.VectorOptions
@exportSymbol ol.source.Vector
@exportProperty ol.source.Vector.prototype.addFeatures
+1 -1
View File
@@ -32,7 +32,7 @@ ol.source.VectorLoadState = {
/**
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.VectorOptions=} opt_options Vector source options.
* @param {olx.source.VectorOptions=} opt_options Vector source options.
* @todo stability experimental
*/
ol.source.Vector = function(opt_options) {
+4 -11
View File
@@ -7,13 +7,6 @@ goog.require('goog.object');
goog.require('goog.uri.utils');
/**
* @typedef {{method: (ol.source.WMSGetFeatureInfoMethod|undefined),
* params: (Object.<string,string>|undefined)}}
*/
ol.source.WMSGetFeatureInfoOptions;
/**
* Method to use to get WMS feature info.
* @enum {string}
@@ -74,8 +67,8 @@ ol.source.wms.getUrl =
/**
* @param {string} url URL as provided by the url function.
* @param {ol.Pixel} pixel Pixel.
* @param {ol.source.WMSGetFeatureInfoOptions} options Options as defined in the
* source.
* @param {olx.source.WMSGetFeatureInfoOptions} options Options as defined in
* the source.
* @param {function(string)} success Callback function for successful queries.
* @param {function()=} opt_error Optional callback function for unsuccessful
* queries.
@@ -86,9 +79,9 @@ ol.source.wms.getFeatureInfo =
// closure
url = url.replace('REQUEST=GetMap', 'REQUEST=GetFeatureInfo')
.replace(ol.source.wms.regExes.layers, 'LAYERS=$1&QUERY_LAYERS=$1');
options = /** @type {ol.source.WMSGetFeatureInfoOptions} */
options = /** @type {olx.source.WMSGetFeatureInfoOptions} */
(goog.isDef(options) ? goog.object.clone(options) : {});
var localOptions = /** @type {ol.source.WMSGetFeatureInfoOptions} */ ({
var localOptions = /** @type {olx.source.WMSGetFeatureInfoOptions} */ ({
method: ol.source.WMSGetFeatureInfoMethod.IFRAME,
params: {}
});

Some files were not shown because too many files have changed in this diff Show More