Annotate stable map options

This commit is contained in:
Tim Schaub
2014-08-22 17:43:51 -06:00
parent 07b5b448dc
commit e17e909ffa
+8 -8
View File
@@ -194,7 +194,7 @@ olx.MapOptions;
* Controls initially added to the map. If not specified, * Controls initially added to the map. If not specified,
* {@link ol.control.defaults ol.control.defaults()} is used. * {@link ol.control.defaults ol.control.defaults()} is used.
* @type {ol.Collection.<ol.control.Control>|Array.<ol.control.Control>|undefined} * @type {ol.Collection.<ol.control.Control>|Array.<ol.control.Control>|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.controls; olx.MapOptions.prototype.controls;
@@ -220,7 +220,7 @@ olx.MapOptions.prototype.pixelRatio;
* Interactions that are initially added to the map. If not specified, * Interactions that are initially added to the map. If not specified,
* {@link ol.interaction.defaults ol.interaction.defaults()} is used. * {@link ol.interaction.defaults ol.interaction.defaults()} is used.
* @type {ol.Collection.<ol.interaction.Interaction>|Array.<ol.interaction.Interaction>|undefined} * @type {ol.Collection.<ol.interaction.Interaction>|Array.<ol.interaction.Interaction>|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.interactions; olx.MapOptions.prototype.interactions;
@@ -242,7 +242,7 @@ olx.MapOptions.prototype.keyboardEventTarget;
/** /**
* Layers. If this is not defined, a map with no layers will be rendered. * Layers. If this is not defined, a map with no layers will be rendered.
* @type {Array.<ol.layer.Base>|ol.Collection.<ol.layer.Base>|undefined} * @type {Array.<ol.layer.Base>|ol.Collection.<ol.layer.Base>|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.layers; olx.MapOptions.prototype.layers;
@@ -254,7 +254,7 @@ olx.MapOptions.prototype.layers;
* property should be a URL for creating a link. To disable the map logo, set * property should be a URL for creating a link. To disable the map logo, set
* the option to `false`. By default, the OpenLayers 3 logo is shown. * the option to `false`. By default, the OpenLayers 3 logo is shown.
* @type {boolean|string|olx.LogoOptions|undefined} * @type {boolean|string|olx.LogoOptions|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.logo; olx.MapOptions.prototype.logo;
@@ -262,7 +262,7 @@ olx.MapOptions.prototype.logo;
/** /**
* Overlays initially added to the map. By default, no overlays are added. * Overlays initially added to the map. By default, no overlays are added.
* @type {ol.Collection.<ol.Overlay>|Array.<ol.Overlay>|undefined} * @type {ol.Collection.<ol.Overlay>|Array.<ol.Overlay>|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.overlays; olx.MapOptions.prototype.overlays;
@@ -273,7 +273,7 @@ olx.MapOptions.prototype.overlays;
* {@link ol.RendererType} here to use a specific renderer. * {@link ol.RendererType} here to use a specific renderer.
* Note that at present only the Canvas renderer supports vector data. * Note that at present only the Canvas renderer supports vector data.
* @type {ol.RendererType|Array.<ol.RendererType|string>|string|undefined} * @type {ol.RendererType|Array.<ol.RendererType|string>|string|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.renderer; olx.MapOptions.prototype.renderer;
@@ -283,7 +283,7 @@ olx.MapOptions.prototype.renderer;
* element. If not specified at construction time, {@link ol.Map#setTarget} * element. If not specified at construction time, {@link ol.Map#setTarget}
* must be called for the map to be rendered. * must be called for the map to be rendered.
* @type {Element|string|undefined} * @type {Element|string|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.target; olx.MapOptions.prototype.target;
@@ -292,7 +292,7 @@ olx.MapOptions.prototype.target;
* The map's view. No layer sources will be fetched unless this is specified at * The map's view. No layer sources will be fetched unless this is specified at
* construction time or through {@link ol.Map#setView}. * construction time or through {@link ol.Map#setView}.
* @type {ol.View|undefined} * @type {ol.View|undefined}
* @api * @api stable
*/ */
olx.MapOptions.prototype.view; olx.MapOptions.prototype.view;