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

@@ -21,7 +21,6 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
* @todo api
*/
ol.control.Attribution = function(opt_options) {

View File

@@ -16,8 +16,7 @@ goog.require('ol.Object');
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options.
* @todo stability stable
* @todo api
* @todo api stable
*/
ol.control.Control = function(options) {
@@ -64,7 +63,6 @@ ol.control.Control.prototype.disposeInternal = function() {
/**
* Get the map associated with this control.
* @return {ol.Map} Map.
* @todo stability experimental
* @todo api
*/
ol.control.Control.prototype.getMap = function() {
@@ -86,8 +84,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
* Subclasses may set up event handlers to get notified about changes to
* the map here.
* @param {ol.Map} map Map.
* @todo stability stable
* @todo api
* @todo api stable
*/
ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) {

View File

@@ -9,7 +9,6 @@ goog.require('ol.control.Zoom');
/**
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo stability experimental
* @todo api
*/
ol.control.defaults = function(opt_options) {

View File

@@ -24,7 +24,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.control.FullScreen = function(opt_options) {

View File

@@ -17,7 +17,6 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
* @todo api
*/
ol.control.Logo = function(opt_options) {

View File

@@ -42,7 +42,6 @@ ol.control.MousePositionProperty = {
* mouse position in
* @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
* render the current position in
* @todo stability experimental
* @todo api
*/
ol.control.MousePosition = function(opt_options) {
@@ -133,8 +132,8 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
/**
* @return {ol.CoordinateFormatType|undefined} projection.
* @todo stability experimental
* @return {ol.CoordinateFormatType|undefined} Coordinate format.
* @todo api
*/
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -147,8 +146,8 @@ goog.exportProperty(
/**
* @return {ol.proj.Projection|undefined} projection.
* @todo stability experimental
* @return {ol.proj.Projection|undefined} Projection.
* @todo api
*/
ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -203,7 +202,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
/**
* @param {ol.CoordinateFormatType} format Coordinate format.
* @todo stability experimental
* @todo api
*/
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -216,7 +215,7 @@ goog.exportProperty(
/**
* @param {ol.proj.Projection} projection Projection.
* @todo stability experimental
* @todo api
*/
ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection);

View File

@@ -20,7 +20,6 @@ goog.require('ol.sphere.NORMAL');
/**
* @enum {string}
* @todo stability experimental
*/
ol.control.ScaleLineProperty = {
UNITS: 'units'
@@ -28,8 +27,10 @@ ol.control.ScaleLineProperty = {
/**
* Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
* `'nautical'`, `'metric'`, `'us'`.
* @enum {string}
* @todo stability experimental
* @todo api
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.control.ScaleLineUnits = {
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line
* @todo stability experimental
* @todo api
*/
ol.control.ScaleLine = function(opt_options) {
@@ -132,14 +132,13 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
/**
* @const
* @type {Array.<number>}
* @todo stability experimental
*/
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/**
* @return {ol.control.ScaleLineUnits|undefined} units.
* @todo stability experimental
* @todo api
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -175,7 +174,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units Units.
* @todo stability experimental
* @todo api
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);

View File

@@ -23,7 +23,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
* @todo api
*/
ol.control.Zoom = function(opt_options) {

View File

@@ -38,7 +38,6 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
* @todo api
*/
ol.control.ZoomSlider = function(opt_options) {

View File

@@ -20,7 +20,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.control.ZoomToExtent = function(opt_options) {