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:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions

View File

@@ -23,7 +23,6 @@ goog.require('ol.proj.Units');
/**
* @enum {string}
* @todo stability experimental
*/
ol.View2DProperty = {
CENTER: 'center',
@@ -86,7 +85,6 @@ ol.View2DProperty = {
* @implements {ol.IView3D}
* @extends {ol.View}
* @param {olx.View2DOptions=} opt_options View2D options.
* @todo stability experimental
* @todo observable center {ol.Coordinate} the center of the view
* @todo observable projection {ol.proj.Projection} the projection of the view
* @todo observable resolution {number} the resolution of the view
@@ -197,7 +195,6 @@ ol.View2D.prototype.constrainCenter = function(center) {
* @param {number=} opt_delta Delta. Default is `0`.
* @param {number=} opt_direction Direction. Default is `0`.
* @return {number|undefined} Constrained resolution.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.constrainResolution = function(
@@ -213,7 +210,6 @@ ol.View2D.prototype.constrainResolution = function(
* @param {number|undefined} rotation Rotation.
* @param {number=} opt_delta Delta. Default is `0`.
* @return {number|undefined} Constrained rotation.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) {
@@ -224,6 +220,7 @@ ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) {
/**
* @inheritDoc
* @todo api
*/
ol.View2D.prototype.getCenter = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -240,7 +237,6 @@ goog.exportProperty(
* resolution and the current center.
* @param {ol.Size} size Box pixel size.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.calculateExtent = function(size) {
@@ -257,6 +253,7 @@ ol.View2D.prototype.calculateExtent = function(size) {
/**
* @inheritDoc
* @todo api
*/
ol.View2D.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -270,6 +267,7 @@ goog.exportProperty(
/**
* @inheritDoc
* @todo api
*/
ol.View2D.prototype.getResolution = function() {
return /** @type {number|undefined} */ (
@@ -320,6 +318,7 @@ ol.View2D.prototype.getResolutionForValueFunction = function(opt_power) {
/**
* @inheritDoc
* @todo api
*/
ol.View2D.prototype.getRotation = function() {
return /** @type {number|undefined} */ (this.get(ol.View2DProperty.ROTATION));
@@ -393,7 +392,6 @@ ol.View2D.prototype.getView3D = function() {
* Get the current zoom level. Return undefined if the current
* resolution is undefined or not a "constrained resolution".
* @return {number|undefined} Zoom.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.getZoom = function() {
@@ -420,7 +418,6 @@ ol.View2D.prototype.getZoom = function() {
* Fit the given extent based on the given map size.
* @param {ol.Extent} extent Extent.
* @param {ol.Size} size Box pixel size.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.fitExtent = function(extent, size) {
@@ -443,7 +440,6 @@ ol.View2D.prototype.fitExtent = function(extent, size) {
* @param {ol.geom.SimpleGeometry} geometry Geometry.
* @param {ol.Size} size Box pixel size.
* @param {olx.View2D.fitGeometryOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) {
@@ -511,7 +507,6 @@ ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Size} size Box pixel size.
* @param {ol.Pixel} position Position on the view to center on.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.centerOn = function(coordinate, size, position) {
@@ -561,7 +556,7 @@ ol.View2D.prototype.rotate = function(rotation, opt_anchor) {
/**
* Set the center of the current view.
* @param {ol.Coordinate|undefined} center Center.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setCenter = function(center) {
this.set(ol.View2DProperty.CENTER, center);
@@ -576,7 +571,7 @@ goog.exportProperty(
* Set the projection of this view.
* Warning! This code is not yet implemented. Function should not be used.
* @param {ol.proj.Projection|undefined} projection Projection.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setProjection = function(projection) {
this.set(ol.View2DProperty.PROJECTION, projection);
@@ -590,7 +585,7 @@ goog.exportProperty(
/**
* Set the resolution for this view.
* @param {number|undefined} resolution Resolution.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setResolution = function(resolution) {
this.set(ol.View2DProperty.RESOLUTION, resolution);
@@ -604,7 +599,7 @@ goog.exportProperty(
/**
* Set the rotation for this view.
* @param {number|undefined} rotation Rotation.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setRotation = function(rotation) {
this.set(ol.View2DProperty.ROTATION, rotation);
@@ -618,7 +613,6 @@ goog.exportProperty(
/**
* Zoom to a specific zoom level.
* @param {number} zoom Zoom level.
* @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setZoom = function(zoom) {