All @api annotations imply stability
This commit is contained in:
+14
-14
@@ -38,7 +38,7 @@ goog.require('ol.sphere.WGS84');
|
||||
* @constructor
|
||||
* @extends {ol.Object}
|
||||
* @param {olx.GeolocationOptions=} opt_options Options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation = function(opt_options) {
|
||||
|
||||
@@ -182,7 +182,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
|
||||
* @return {number|undefined} The accuracy of the position measurement in
|
||||
* meters.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getAccuracy = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -194,7 +194,7 @@ ol.Geolocation.prototype.getAccuracy = function() {
|
||||
* Get a geometry of the position accuracy.
|
||||
* @return {?ol.geom.Geometry} A geometry of the position accuracy.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getAccuracyGeometry = function() {
|
||||
return /** @type {?ol.geom.Geometry} */ (
|
||||
@@ -207,7 +207,7 @@ ol.Geolocation.prototype.getAccuracyGeometry = function() {
|
||||
* @return {number|undefined} The altitude of the position in meters above mean
|
||||
* sea level.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getAltitude = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -220,7 +220,7 @@ ol.Geolocation.prototype.getAltitude = function() {
|
||||
* @return {number|undefined} The accuracy of the altitude measurement in
|
||||
* meters.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -232,7 +232,7 @@ ol.Geolocation.prototype.getAltitudeAccuracy = function() {
|
||||
* Get the heading as radians clockwise from North.
|
||||
* @return {number|undefined} The heading of the device in radians from north.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getHeading = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -245,7 +245,7 @@ ol.Geolocation.prototype.getHeading = function() {
|
||||
* @return {ol.Coordinate|undefined} The current position of the device reported
|
||||
* in the current projection.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getPosition = function() {
|
||||
return /** @type {ol.Coordinate|undefined} */ (
|
||||
@@ -258,7 +258,7 @@ ol.Geolocation.prototype.getPosition = function() {
|
||||
* @return {ol.proj.Projection|undefined} The projection the position is
|
||||
* reported in.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getProjection = function() {
|
||||
return /** @type {ol.proj.Projection|undefined} */ (
|
||||
@@ -271,7 +271,7 @@ ol.Geolocation.prototype.getProjection = function() {
|
||||
* @return {number|undefined} The instantaneous speed of the device in meters
|
||||
* per second.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getSpeed = function() {
|
||||
return /** @type {number|undefined} */ (
|
||||
@@ -283,7 +283,7 @@ ol.Geolocation.prototype.getSpeed = function() {
|
||||
* Determine if the device location is being tracked.
|
||||
* @return {boolean} The device location is being tracked.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getTracking = function() {
|
||||
return /** @type {boolean} */ (
|
||||
@@ -298,7 +298,7 @@ ol.Geolocation.prototype.getTracking = function() {
|
||||
* the [HTML5 Geolocation spec
|
||||
* ](http://www.w3.org/TR/geolocation-API/#position_options_interface).
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.getTrackingOptions = function() {
|
||||
return /** @type {GeolocationPositionOptions|undefined} */ (
|
||||
@@ -311,7 +311,7 @@ ol.Geolocation.prototype.getTrackingOptions = function() {
|
||||
* @param {ol.proj.Projection} projection The projection the position is
|
||||
* reported in.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.setProjection = function(projection) {
|
||||
this.set(ol.GeolocationProperty.PROJECTION, projection);
|
||||
@@ -322,7 +322,7 @@ ol.Geolocation.prototype.setProjection = function(projection) {
|
||||
* Enable or disable tracking.
|
||||
* @param {boolean} tracking Enable tracking.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.setTracking = function(tracking) {
|
||||
this.set(ol.GeolocationProperty.TRACKING, tracking);
|
||||
@@ -336,7 +336,7 @@ ol.Geolocation.prototype.setTracking = function(tracking) {
|
||||
* [HTML5 Geolocation spec
|
||||
* ](http://www.w3.org/TR/geolocation-API/#position_options_interface).
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.Geolocation.prototype.setTrackingOptions = function(options) {
|
||||
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);
|
||||
|
||||
Reference in New Issue
Block a user