Add default stability level to docs of exported things.

This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions

View File

@@ -15,6 +15,7 @@ ol.interaction.ConditionType;
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed.
* @todo stability experimental
*/
ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -28,6 +29,7 @@ ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed.
* @todo stability experimental
*/
ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -42,6 +44,7 @@ ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* Always true.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True.
* @todo stability experimental
*/
ol.interaction.condition.always = goog.functions.TRUE;
@@ -49,6 +52,7 @@ ol.interaction.condition.always = goog.functions.TRUE;
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if the event is a click event.
* @todo stability experimental
*/
ol.interaction.condition.clickOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -59,6 +63,7 @@ ol.interaction.condition.clickOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed.
* @todo stability experimental
*/
ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -72,6 +77,7 @@ ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed.
* @todo stability experimental
*/
ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -85,6 +91,7 @@ ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed.
* @todo stability experimental
*/
ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -98,6 +105,7 @@ ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable.
* @todo stability experimental
*/
ol.interaction.condition.targetNotEditable = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;

View File

@@ -15,6 +15,7 @@ goog.require('ol.interaction.Interaction');
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DoubleClickZoom = function(opt_options) {

View File

@@ -18,6 +18,7 @@ goog.require('ol.interaction.condition');
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragPan = function(opt_options) {

View File

@@ -26,6 +26,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragRotateAndZoom = function(opt_options) {

View File

@@ -35,6 +35,7 @@ ol.SHIFT_DRAG_ZOOM_HYSTERESIS_PIXELS_SQUARED =
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragZoom = function(opt_options) {

View File

@@ -26,6 +26,7 @@ goog.require('ol.interaction.TouchZoom');
* @param {ol.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
*/
ol.interaction.defaults = function(opt_options) {

View File

@@ -25,6 +25,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.KeyboardPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.KeyboardPan = function(opt_options) {

View File

@@ -15,6 +15,7 @@ goog.require('ol.interaction.condition');
* @constructor
* @param {ol.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction}
* @todo stability experimental
*/
ol.interaction.KeyboardZoom = function(opt_options) {

View File

@@ -28,6 +28,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.MouseWheelZoom = function(opt_options) {

View File

@@ -17,6 +17,7 @@ goog.require('ol.source.Vector');
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.SelectOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.Select = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};

View File

@@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch');
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchPan = function(opt_options) {

View File

@@ -22,6 +22,7 @@ ol.interaction.TOUCHROTATE_ANIMATION_DURATION = 250;
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchRotateOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchRotate = function(opt_options) {

View File

@@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch');
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchZoom = function(opt_options) {