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

@@ -26,6 +26,7 @@ ol.OverlayProperty = {
/**
* @enum {string}
* @todo stability experimental
*/
ol.OverlayPositioning = {
BOTTOM_LEFT: 'bottom-left',
@@ -55,6 +56,7 @@ ol.OverlayPositioning = {
* @constructor
* @extends {ol.Object}
* @param {ol.OverlayOptions} options Overlay options.
* @todo stability experimental
*/
ol.Overlay = function(options) {
@@ -129,6 +131,7 @@ goog.inherits(ol.Overlay, ol.Object);
/**
* Get the DOM element of this overlay.
* @return {Element|undefined} Element.
* @todo stability experimental
*/
ol.Overlay.prototype.getElement = function() {
return /** @type {Element|undefined} */ (
@@ -143,6 +146,7 @@ goog.exportProperty(
/**
* Get the map associated with this overlay.
* @return {ol.Map|undefined} Map.
* @todo stability experimental
*/
ol.Overlay.prototype.getMap = function() {
return /** @type {ol.Map|undefined} */ (
@@ -157,6 +161,7 @@ goog.exportProperty(
/**
* Get the current position of this overlay.
* @return {ol.Coordinate|undefined} Position.
* @todo stability experimental
*/
ol.Overlay.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -171,6 +176,7 @@ goog.exportProperty(
/**
* Get the current positioning of this overlay.
* @return {ol.OverlayPositioning|undefined} Positioning.
* @todo stability experimental
*/
ol.Overlay.prototype.getPositioning = function() {
return /** @type {ol.OverlayPositioning|undefined} */ (
@@ -243,6 +249,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
/**
* Set the DOM element to be associated with this overlay.
* @param {Element|undefined} element Element.
* @todo stability experimental
*/
ol.Overlay.prototype.setElement = function(element) {
this.set(ol.OverlayProperty.ELEMENT, element);
@@ -256,6 +263,7 @@ goog.exportProperty(
/**
* Set the map to be associated with this overlay.
* @param {ol.Map|undefined} map Map.
* @todo stability experimental
*/
ol.Overlay.prototype.setMap = function(map) {
this.set(ol.OverlayProperty.MAP, map);
@@ -269,6 +277,7 @@ goog.exportProperty(
/**
* Set the position for this overlay.
* @param {ol.Coordinate|undefined} position Position.
* @todo stability experimental
*/
ol.Overlay.prototype.setPosition = function(position) {
this.set(ol.OverlayProperty.POSITION, position);
@@ -282,6 +291,7 @@ goog.exportProperty(
/**
* Set the positioning for this overlay.
* @param {ol.OverlayPositioning|undefined} positioning Positioning.
* @todo stability experimental
*/
ol.Overlay.prototype.setPositioning = function(positioning) {
this.set(ol.OverlayProperty.POSITIONING, positioning);