Merge pull request openlayers#1103 from fredj/doc

Minor apidoc updates
rickj33 · Oct 8, 2013 · b022da3 · b022da3
2 parents aca022d + 307e2d9
commit b022da3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc
@@ -7,12 +7,12 @@
 
 /**
  * @typedef {Object} ol.DeviceOrientationOptions
- * @property {boolean|undefined} tracking Tracking.
+ * @property {boolean|undefined} tracking Start tracking. Default is false.
  */
 
 /**
  * @typedef {Object} ol.GeolocationOptions
- * @property {boolean|undefined} tracking Tracking.
+ * @property {boolean|undefined} tracking Start Tracking. Default is false.
  * @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
  * @property {ol.proj.ProjectionLike} projection Projection.
  */

diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js
@@ -182,7 +182,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
 
 /**
  * Get the accuracy of the position in meters.
- * @return {number|undefined} accuracy in meters.
+ * @return {number|undefined} Position accuracy in meters.
  */
 ol.Geolocation.prototype.getAccuracy = function() {
   return /** @type {number|undefined} */ (
@@ -210,7 +210,7 @@ goog.exportProperty(
 
 /**
  * Get the altitude accuracy of the position.
- * @return {number|undefined} Altitude accuracy.
+ * @return {number|undefined} Altitude accuracy in meters.
  */
 ol.Geolocation.prototype.getAltitudeAccuracy = function() {
   return /** @type {number|undefined} */ (

diff --git a/src/ol/map.js b/src/ol/map.js
@@ -136,7 +136,7 @@ ol.MapProperty = {
  *     });
  *
  * The above snippet creates a map with a MapQuest OSM layer on a 2D view and
- * renders it to a DOM element with the id 'map'.
+ * renders it to a DOM element with the id `map`.
  *
  * @constructor
  * @extends {ol.Object}