Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / src / slider / Single.js

diff --git a/src/slider/Single.js b/src/slider/Single.js
index 9ee4ab7..f0f8400 100644 (file)
--- a/src/slider/Single.js
+++ b/src/slider/Single.js
@@ -13,23 +13,19 @@ If you are unsure which license is appropriate for your use, please contact the
 
 */
 /**
- * @class Ext.slider.Single
- * @extends Ext.slider.Multi
- * Slider which supports vertical or horizontal orientation, keyboard adjustments,
- * configurable snapping, axis clicking and animation. Can be added as an item to
- * any container. 
- * {@img Ext.slider.Single/Ext.slider.Single.png Ext.slider.Single component}
- * Example usage:
-<pre><code>
-    Ext.create('Ext.slider.Single', {
-        width: 200,
-        value: 50,
-        increment: 10,
-        minValue: 0,
-        maxValue: 100,
-        renderTo: Ext.getBody()
-    });
-</code></pre>
+ * Slider which supports vertical or horizontal orientation, keyboard adjustments, configurable snapping, axis clicking
+ * and animation. Can be added as an item to any container.
+ *
+ *     @example
+ *     Ext.create('Ext.slider.Single', {
+ *         width: 200,
+ *         value: 50,
+ *         increment: 10,
+ *         minValue: 0,
+ *         maxValue: 100,
+ *         renderTo: Ext.getBody()
+ *     });
+ *
  * The class Ext.slider.Single is aliased to Ext.Slider for backwards compatibility.
  */
 Ext.define('Ext.slider.Single', {
@@ -42,23 +38,23 @@ Ext.define('Ext.slider.Single', {
      * @return {Number} The current value of the slider
      */
     getValue: function() {
-        //just returns the value of the first thumb, which should be the only one in a single slider
+        // just returns the value of the first thumb, which should be the only one in a single slider
         return this.callParent([0]);
     },
 
     /**
-     * Programmatically sets the value of the Slider. Ensures that the value is constrained within
-     * the minValue and maxValue.
+     * Programmatically sets the value of the Slider. Ensures that the value is constrained within the minValue and
+     * maxValue.
      * @param {Number} value The value to set the slider to. (This will be constrained within minValue and maxValue)
-     * @param {Boolean} animate Turn on or off animation, defaults to true
+     * @param {Boolean} [animate] Turn on or off animation
      */
     setValue: function(value, animate) {
         var args = Ext.toArray(arguments),
             len  = args.length;
 
-        //this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
-        //index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
-        //signature without the required index. The index will always be 0 for a single slider
+        // this is to maintain backwards compatiblity for sliders with only one thunb. Usually you must pass the thumb
+        // index to setValue, but if we only have one thumb we inject the index here first if given the multi-slider
+        // signature without the required index. The index will always be 0 for a single slider
         if (len == 1 || (len <= 3 && typeof arguments[1] != 'number')) {
             args.unshift(0);
         }