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
@@ -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);
|
||||
|
||||
Reference in New Issue
Block a user