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

@@ -71,7 +71,6 @@ ol.GeolocationProperty = {
* @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
* as defined by the HTML5 Geolocation spec at
* http://www.w3.org/TR/geolocation-API/#position_options_interface
* @todo stability experimental
* @todo api
*/
ol.Geolocation = function(opt_options) {
@@ -207,7 +206,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
/**
* Get the accuracy of the position in meters.
* @return {number|undefined} Position accuracy in meters.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getAccuracy = function() {
return /** @type {number|undefined} */ (
@@ -222,7 +221,7 @@ goog.exportProperty(
/**
* Get a geometry of the position accuracy.
* @return {?ol.geom.Geometry} Accuracy geometry.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getAccuracyGeometry = function() {
return /** @type {?ol.geom.Geometry} */ (
@@ -237,7 +236,7 @@ goog.exportProperty(
/**
* Get the altitude associated with the position.
* @return {number|undefined} The altitude in meters above the mean sea level.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getAltitude = function() {
return /** @type {number|undefined} */ (
@@ -252,7 +251,7 @@ goog.exportProperty(
/**
* Get the altitude accuracy of the position.
* @return {number|undefined} Altitude accuracy in meters.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
return /** @type {number|undefined} */ (
@@ -267,7 +266,7 @@ goog.exportProperty(
/**
* Get the heading as radians clockwise from North.
* @return {number|undefined} Heading.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getHeading = function() {
return /** @type {number|undefined} */ (
@@ -282,7 +281,7 @@ goog.exportProperty(
/**
* Get the position of the device.
* @return {ol.Coordinate|undefined} position.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -297,7 +296,7 @@ goog.exportProperty(
/**
* Get the projection associated with the position.
* @return {ol.proj.Projection|undefined} projection.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -312,7 +311,7 @@ goog.exportProperty(
/**
* Get the speed in meters per second.
* @return {number|undefined} Speed.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getSpeed = function() {
return /** @type {number|undefined} */ (
@@ -327,7 +326,7 @@ goog.exportProperty(
/**
* Are we tracking the user's position?
* @return {boolean} tracking.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getTracking = function() {
return /** @type {boolean} */ (
@@ -344,7 +343,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
* tracking options.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.getTrackingOptions = function() {
return /** @type {GeolocationPositionOptions|undefined} */ (
@@ -359,7 +358,7 @@ goog.exportProperty(
/**
* Set the projection to use for transforming the coordinates.
* @param {ol.proj.Projection} projection Projection.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.setProjection = function(projection) {
this.set(ol.GeolocationProperty.PROJECTION, projection);
@@ -373,7 +372,7 @@ goog.exportProperty(
/**
* Enable/disable tracking.
* @param {boolean} tracking Enable or disable tracking.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.setTracking = function(tracking) {
this.set(ol.GeolocationProperty.TRACKING, tracking);
@@ -389,7 +388,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @param {GeolocationPositionOptions} options HTML 5 Geolocation
* tracking options.
* @todo stability experimental
* @todo api
*/
ol.Geolocation.prototype.setTrackingOptions = function(options) {
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);