Get rid of stability annotations and document stability with api
This change adds a stability value to the api annotation, with 'experimental' as default value. enum, typedef and event annotations are never exportable, but api annotations are needed there to make them appear in the docs. Nested typedefs are no longer inlined recursively, because the resulting tables get too wide with the current template.
This commit is contained in:
committed by
Tim Schaub
parent
29b643c7b0
commit
fbdbbfb7a7
@@ -25,8 +25,11 @@ ol.OverlayProperty = {
|
||||
|
||||
|
||||
/**
|
||||
* Overlay position: `'bottom-left'`, `'bottom-center'`, `'bottom-right'`,
|
||||
* `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`,
|
||||
* `'top-center'`, `'top-right'`
|
||||
* @enum {string}
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.OverlayPositioning = {
|
||||
BOTTOM_LEFT: 'bottom-left',
|
||||
@@ -62,8 +65,7 @@ ol.OverlayPositioning = {
|
||||
* is anchored at
|
||||
* @todo observable positioning {ol.OverlayPositioning} how the overlay is
|
||||
* positioned relative to its point on the map
|
||||
* @todo stability stable
|
||||
* @todo api
|
||||
* @todo api stable
|
||||
*/
|
||||
ol.Overlay = function(options) {
|
||||
|
||||
@@ -158,7 +160,7 @@ goog.inherits(ol.Overlay, ol.Object);
|
||||
/**
|
||||
* Get the DOM element of this overlay.
|
||||
* @return {Element|undefined} Element.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.getElement = function() {
|
||||
return /** @type {Element|undefined} */ (
|
||||
@@ -173,7 +175,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Get the map associated with this overlay.
|
||||
* @return {ol.Map|undefined} Map.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.getMap = function() {
|
||||
return /** @type {ol.Map|undefined} */ (
|
||||
@@ -188,7 +190,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Get the current position of this overlay.
|
||||
* @return {ol.Coordinate|undefined} Position.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.getPosition = function() {
|
||||
return /** @type {ol.Coordinate|undefined} */ (
|
||||
@@ -203,7 +205,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Get the current positioning of this overlay.
|
||||
* @return {ol.OverlayPositioning|undefined} Positioning.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.getPositioning = function() {
|
||||
return /** @type {ol.OverlayPositioning|undefined} */ (
|
||||
@@ -280,7 +282,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
|
||||
/**
|
||||
* Set the DOM element to be associated with this overlay.
|
||||
* @param {Element|undefined} element Element.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.setElement = function(element) {
|
||||
this.set(ol.OverlayProperty.ELEMENT, element);
|
||||
@@ -294,7 +296,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Set the map to be associated with this overlay.
|
||||
* @param {ol.Map|undefined} map Map.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.setMap = function(map) {
|
||||
this.set(ol.OverlayProperty.MAP, map);
|
||||
@@ -308,7 +310,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Set the position for this overlay.
|
||||
* @param {ol.Coordinate|undefined} position Position.
|
||||
* @todo stability stable
|
||||
* @todo api stable
|
||||
*/
|
||||
ol.Overlay.prototype.setPosition = function(position) {
|
||||
this.set(ol.OverlayProperty.POSITION, position);
|
||||
@@ -322,7 +324,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Set the positioning for this overlay.
|
||||
* @param {ol.OverlayPositioning|undefined} positioning Positioning.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Overlay.prototype.setPositioning = function(positioning) {
|
||||
this.set(ol.OverlayProperty.POSITIONING, positioning);
|
||||
|
||||
Reference in New Issue
Block a user