Minor apidoc updates

src/ol/control/mousepositioncontrol.js

@@ -40,8 +40,8 @@ ol.control.MousePositionProperty = {
  * @todo stability experimental
  * @todo observable projection {ol.proj.Projection} the projection to report
  *       mouse position in
- * @todo observable coordinateFormat {string} the format to render the current
- *       position in
+ * @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
+ *       render the current position in
  */
 ol.control.MousePosition = function(opt_options) {
 

src/ol/geolocation.js

@@ -62,8 +62,9 @@ ol.GeolocationProperty = {
  * @todo observable speed {number} readonly the instantaneous speed of the
  *       device in meters per second
  * @todo observable tracking {number} track the device's position.
- * @todo observable trackingOptions {number} PositionOptions as defined by the
- *       HTML5 Geolocation spec at http://dev.w3.org/geo/api/spec-source.html
+ * @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
+ *       as defined by the HTML5 Geolocation spec at
+ *       http://dev.w3.org/geo/api/spec-source.html
  */
 ol.Geolocation = function(opt_options) {
 

src/ol/geom/linearring.js

@@ -10,7 +10,7 @@ goog.require('ol.geom.LineString');
  * @constructor
  * @extends {ol.geom.LineString}
  * @param {ol.CoordinateArray} coordinates Vertex array (e.g.
- *    [[x0, y0], [x1, y1]]).
+ *    `[[x0, y0], [x1, y1]]`).
  * @todo stability experimental
  */
 ol.geom.LinearRing = function(coordinates) {

src/ol/geom/linestring.js

@@ -15,7 +15,7 @@ goog.require('ol.geom.GeometryType');
  * @constructor
  * @extends {ol.geom.Geometry}
  * @param {ol.CoordinateArray} coordinates Array of coordinates (e.g.
- *    [[x0, y0], [x1, y1]]).
+ *    `[[x0, y0], [x1, y1]]`).
  * @todo stability experimental
  */
 ol.geom.LineString = function(coordinates) {

src/ol/geom/point.js

@@ -12,7 +12,7 @@ goog.require('ol.geom.GeometryType');
 /**
  * @constructor
  * @extends {ol.geom.Geometry}
- * @param {ol.Coordinate} coordinates Coordinate values (e.g. [x, y]).
+ * @param {ol.Coordinate} coordinates Coordinate values (e.g. `[x, y]`).
  * @todo stability experimental
  */
 ol.geom.Point = function(coordinates) {

src/ol/object.js

@@ -142,7 +142,7 @@ ol.Object.getAccessors = function(obj) {
 
 
 /**
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @return {string} Change name.
  */
 ol.Object.getChangeEventType = function(key) {
@@ -207,7 +207,7 @@ ol.Object.getSetterName = function(key) {
  *         }
  *       );
  *
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @param {ol.Object} target Target.
  * @param {string=} opt_targetKey Target key.
  * @return {ol.ObjectAccessor}
@@ -231,7 +231,7 @@ ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
 
 /**
  * Gets a value.
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @return {*} Value.
  * @todo stability experimental
  */
@@ -291,7 +291,7 @@ ol.Object.prototype.getKeys = function() {
  * Notify all observers of a change on this property. This notifies both
  * objects that are bound to the object's property as well as the object
  * that it is bound to.
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @todo stability experimental
  */
 ol.Object.prototype.notify = function(key) {
@@ -308,7 +308,7 @@ ol.Object.prototype.notify = function(key) {
 
 
 /**
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @private
  */
 ol.Object.prototype.notifyInternal_ = function(key) {
@@ -348,7 +348,7 @@ ol.Object.prototype.once = function(type, listener, opt_scope) {
 
 /**
  * Sets a value.
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @param {*} value Value.
  * @todo stability experimental
  */
@@ -394,7 +394,7 @@ ol.Object.prototype.setValues = function(values) {
 /**
  * Removes a binding. Unbinding will set the unbound property to the current
  *     value. The object will not be notified, as the value has not changed.
- * @param {string} key Key.
+ * @param {string} key Key name.
  * @todo stability experimental
  */
 ol.Object.prototype.unbind = function(key) {

src/ol/view2d.js

@@ -192,8 +192,8 @@ ol.View2D.prototype.constrainCenter = function(center) {
 /**
  * Get the constrained the resolution of this view.
  * @param {number|undefined} resolution Resolution.
- * @param {number=} opt_delta Delta.
- * @param {number=} opt_direction Direction.
+ * @param {number=} opt_delta Delta. Default is `0`.
+ * @param {number=} opt_direction Direction. Default is `0`.
  * @return {number|undefined} Constrained resolution.
  * @todo stability experimental
  */
@@ -208,7 +208,7 @@ ol.View2D.prototype.constrainResolution = function(
 /**
  * Get the constrained rotation of this view.
  * @param {number|undefined} rotation Rotation.
- * @param {number=} opt_delta Delta.
+ * @param {number=} opt_delta Delta. Default is `0`.
  * @return {number|undefined} Constrained rotation.
  * @todo stability experimental
  */