Merge all changes from the naturaldocs sandbox. This brings all the work that

has been done in the NaturalDocs branch back to trunk. Thanks to everyone who
helped out in making this happen. (I could list people, but the list would
be long, and I'm already mentally on vacation.)


git-svn-id: http://svn.openlayers.org/trunk/openlayers@3545 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

lib/OpenLayers/Control/MouseToolbar.js

@@ -4,10 +4,12 @@
 
 
 /**
- * @class
- * 
  * @requires OpenLayers/Control.js
  * @requires OpenLayers/Control/MouseDefaults.js
+ *
+ * Class: OpenLayers.Control.MouseToolbar
+ * This class is DEPRECATED in 2.4 and will be removed by 3.0.
+ * If you need this functionality, use Control.NavToolbar instead!!! 
  */
 OpenLayers.Control.MouseToolbar = OpenLayers.Class.create();
 OpenLayers.Control.MouseToolbar.X = 6;
@@ -15,19 +17,34 @@ OpenLayers.Control.MouseToolbar.Y = 300;
 OpenLayers.Control.MouseToolbar.prototype = 
   OpenLayers.Class.inherit( OpenLayers.Control.MouseDefaults, {
     
-    /** WARNING WARNING WARNING!!!
-        This class is DEPRECATED in 2.4 and will be removed by 3.0.
-        If you need this functionality, use Control.NavToolbar instead!!! */
-
+    /**
+     * Property: mode
+     */ 
     mode: null,
-
+    /**
+     * Property: buttons
+     */
     buttons: null,
-
+    
+    /**
+     * APIProperty: direction
+     * {String} 'vertical' or 'horizontal'
+     */
     direction: "vertical",
     
-    /** @type String */
+    /**
+     * Property: buttonClicked
+     * {String}
+     */
     buttonClicked: null,
     
+    /**
+     * Constructor: OpenLayers.Control.MouseToolbar
+     *
+     * Parameters:
+     * position - {<OpenLayers.Pixel>}
+     * direction - {String}
+     */
     initialize: function(position, direction) {
         OpenLayers.Control.prototype.initialize.apply(this, arguments);
         this.position = new OpenLayers.Pixel(OpenLayers.Control.MouseToolbar.X,
@@ -42,7 +59,7 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
     
     /**
-     * 
+     * APIMethod: destroy 
      */
     destroy: function() {
         for( var btnId in this.buttons) {
@@ -54,6 +71,9 @@ OpenLayers.Control.MouseToolbar.prototype =
                                                                  arguments);
     },
     
+    /**
+     * Method: draw
+     */
     draw: function() {
         OpenLayers.Control.prototype.draw.apply(this, arguments); 
         OpenLayers.Control.MouseDefaults.prototype.draw.apply(this, arguments);
@@ -68,7 +88,10 @@ OpenLayers.Control.MouseToolbar.prototype =
 
         return this.div;
     },
-
+    
+    /**
+     * Method: _addButton
+     */
     _addButton:function(id, img, activeImg, xy, sz, title) {
         var imgLocation = OpenLayers.Util.getImagesLocation() + img;
         var activeImgLocation = OpenLayers.Util.getImagesLocation() + activeImg;
@@ -97,7 +120,10 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
 
     /**
-     * @param {Event} evt
+     * Method: buttonDown
+     *
+     * Parameters:
+     * evt - {Event} 
      */
     buttonDown: function(evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;
@@ -106,7 +132,10 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
 
     /**
-     * @param {Event} evt
+     * Method: buttonUp
+     *
+     * Parameters:
+     * evt - {Event} 
      */
     buttonUp: function(evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;
@@ -120,8 +149,11 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
     
     /**
-    * @param {Event} evt
-    */
+     * Method: defaultDblClick 
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultDblClick: function (evt) {
         this.switchModeTo("pan");
         this.performedDrag = false;
@@ -132,8 +164,11 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
 
     /**
-    * @param {Event} evt
-    */
+     * Method: defaultMouseDown
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultMouseDown: function (evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;
         this.mouseDragStart = evt.xy.clone();
@@ -214,6 +249,12 @@ OpenLayers.Control.MouseToolbar.prototype =
         OpenLayers.Event.stop(evt);
     },
 
+    /**
+     * Method: switchModeTo 
+     *
+     * Parameters:
+     * mode - {String} 
+     */
     switchModeTo: function(mode) {
         if (mode != this.mode) {
             
@@ -246,13 +287,19 @@ OpenLayers.Control.MouseToolbar.prototype =
         } 
     }, 
 
+    /**
+     * Method: leaveMode
+     */
     leaveMode: function() {
         this.switchModeTo("pan");
     },
     
     /**
-    * @param {Event} evt
-    */
+     * Method: defaultMouseMove
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultMouseMove: function (evt) {
         if (this.mouseDragStart != null) {
             switch (this.mode) {
@@ -283,8 +330,11 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
 
     /**
-    * @param {Event} evt
-    */
+     * Method: defaultMouseUp
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultMouseUp: function (evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;
         switch (this.mode) {
@@ -303,8 +353,11 @@ OpenLayers.Control.MouseToolbar.prototype =
     },
 
     /**
-    * @param {Event} evt
-    */
+     * Method: defaultMouseOut
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultMouseOut: function (evt) {
         if (this.mouseDragStart != null
             && OpenLayers.Util.mouseLeft(evt, this.map.div)) {
@@ -317,6 +370,12 @@ OpenLayers.Control.MouseToolbar.prototype =
         }
     },
 
+    /**
+     * Method: defaultClick
+     *
+     * Parameters:
+     * evt - {Event} 
+     */
     defaultClick: function (evt) {
         if (this.performedDrag)  {
             this.performedDrag = false;