Merge pull request #2043 from ahocevar/nicer-api-docs

Nicer API docs

src/ol/control/mousepositioncontrol.js

@@ -38,10 +38,6 @@ ol.control.MousePositionProperty = {
  * @extends {ol.control.Control}
  * @param {olx.control.MousePositionOptions=} opt_options Mouse position
  *     options.
- * @todo observable projection {ol.proj.Projection} the projection to report
- *       mouse position in
- * @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
- *       render the current position in
  * @todo api
  */
 ol.control.MousePosition = function(opt_options) {
@@ -132,7 +128,9 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
 
 
 /**
- * @return {ol.CoordinateFormatType|undefined} Coordinate format.
+ * @return {ol.CoordinateFormatType|undefined} The format to render the current
+ *     position in.
+ * @todo observable
  * @todo api
  */
 ol.control.MousePosition.prototype.getCoordinateFormat = function() {
@@ -146,7 +144,9 @@ goog.exportProperty(
 
 
 /**
- * @return {ol.proj.Projection|undefined} Projection.
+ * @return {ol.proj.Projection|undefined} The projection to report mouse
+ *     position in.
+ * @todo observable
  * @todo api
  */
 ol.control.MousePosition.prototype.getProjection = function() {
@@ -201,7 +201,9 @@ ol.control.MousePosition.prototype.setMap = function(map) {
 
 
 /**
- * @param {ol.CoordinateFormatType} format Coordinate format.
+ * @param {ol.CoordinateFormatType} format The format to render the current
+ *     position in.
+ * @todo observable
  * @todo api
  */
 ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
@@ -214,7 +216,9 @@ goog.exportProperty(
 
 
 /**
- * @param {ol.proj.Projection} projection Projection.
+ * @param {ol.proj.Projection} projection The projection to report mouse
+ *     position in.
+ * @todo observable
  * @todo api
  */
 ol.control.MousePosition.prototype.setProjection = function(projection) {

src/ol/control/scalelinecontrol.js

@@ -50,8 +50,6 @@ ol.control.ScaleLineUnits = {
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
- * @todo observable units {ol.control.ScaleLineUnits} the units to use in the
- *       scale line
  * @todo api
  */
 ol.control.ScaleLine = function(opt_options) {
@@ -137,7 +135,9 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
 
 
 /**
- * @return {ol.control.ScaleLineUnits|undefined} units.
+ * @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
+ *     line.
+ * @todo observable
  * @todo api
  */
 ol.control.ScaleLine.prototype.getUnits = function() {
@@ -173,7 +173,8 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
 
 
 /**
- * @param {ol.control.ScaleLineUnits} units Units.
+ * @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
+ * @todo observable
  * @todo api
  */
 ol.control.ScaleLine.prototype.setUnits = function(units) {