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
@@ -79,7 +79,6 @@ ol.DeviceOrientationProperty = {
|
||||
* device from the planar Y axis
|
||||
* @todo observable tracking {boolean} the status of tracking changes to alpha,
|
||||
* beta and gamma. If true, changes are tracked and reported immediately.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation = function(opt_options) {
|
||||
@@ -148,7 +147,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
|
||||
/**
|
||||
* @return {number|undefined} The alpha value of the DeviceOrientation,
|
||||
* in radians.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.getAlpha = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -163,7 +162,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* @return {number|undefined} The beta value of the DeviceOrientation,
|
||||
* in radians.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.getBeta = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -178,7 +177,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* @return {number|undefined} The gamma value of the DeviceOrientation,
|
||||
* in radians.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.getGamma = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -193,7 +192,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* @return {number|undefined} The heading of the device relative to
|
||||
* north, in radians, normalizing for different browser behavior.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.getHeading = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -208,7 +207,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Are we tracking the device's orientation?
|
||||
* @return {boolean} The current tracking state, true if tracking is on.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.getTracking = function() {
|
||||
return /** @type {boolean} */ (
|
||||
@@ -240,7 +239,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
|
||||
/**
|
||||
* Enable or disable tracking of DeviceOrientation events.
|
||||
* @param {boolean} tracking True to enable and false to disable tracking.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.DeviceOrientation.prototype.setTracking = function(tracking) {
|
||||
this.set(ol.DeviceOrientationProperty.TRACKING, tracking);
|
||||
|
||||
Reference in New Issue
Block a user