Documentation enhancements. No functional change.

lib/OpenLayers/Control/MousePosition.js

@@ -13,6 +13,18 @@
  * The MousePosition control displays geographic coordinates of the mouse
  * pointer, as it is moved about the map.
  *
+ * You can use the <prefix>- or <suffix>-properties to provide more information
+ * about the displayed coordinates to the user:
+ *
+ * (code)
+ *     var mousePositionCtrl = new OpenLayers.Control.MousePosition({
+ *         prefix: '<a target="_blank" ' +
+ *             'href="http://spatialreference.org/ref/epsg/4326/">' +
+ *             'EPSG:4326</a> coordinates: '
+ *         }
+ *     );
+ * (end code)
+ *
  * Inherits from:
  *  - <OpenLayers.Control>
  */
@@ -33,25 +45,30 @@ OpenLayers.Control.MousePosition = OpenLayers.Class(OpenLayers.Control, {
 
     /**
      * APIProperty: prefix
-     * {String}
+     * {String} A string to be prepended to the current pointers coordinates
+     *     when it is rendered.  Defaults to the empty string ''.
      */
     prefix: '',
 
     /**
      * APIProperty: separator
-     * {String}
+     * {String} A string to be used to seperate the two coordinates from each
+     *     other.  Defaults to the string ', ', which will result in a
+     *     rendered coordinate of e.g. '42.12, 21.22'.
      */
     separator: ', ',
 
     /**
      * APIProperty: suffix
-     * {String}
+     * {String} A string to be appended to the current pointers coordinates
+     *     when it is rendered.  Defaults to the empty string ''.
      */
     suffix: '',
 
     /**
      * APIProperty: numDigits
-     * {Integer}
+     * {Integer} The number of digits each coordinate shall have when being
+     *     rendered, Defaults to 5.
      */
     numDigits: 5,
 
@@ -76,8 +93,8 @@ OpenLayers.Control.MousePosition = OpenLayers.Class(OpenLayers.Control, {
 
     /**
      * APIProperty: displayProjection
-     * {<OpenLayers.Projection>} The projection in which the 
-     * mouse position is displayed
+     * {<OpenLayers.Projection>} The projection in which the mouse position is
+     *     displayed.
      */
     displayProjection: null,