X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/src/button/Cycle.js

diff --git a/src/button/Cycle.js b/src/button/Cycle.js
index 091fbce3..6d7861d3 100644
--- a/src/button/Cycle.js
+++ b/src/button/Cycle.js
@@ -13,35 +13,31 @@ If you are unsure which license is appropriate for your use, please contact the
 
 */
 /**
- * @class Ext.button.Cycle
- * @extends Ext.button.Split
- * A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements.  The button automatically
+ * A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements. The button automatically
  * cycles through each menu item on click, raising the button's {@link #change} event (or calling the button's
  * {@link #changeHandler} function, if supplied) for the active menu item. Clicking on the arrow section of the
- * button displays the dropdown menu just like a normal SplitButton.  
- * {@img Ext.button.Cycle/Ext.button.Cycle.png Ext.button.Cycle component}
- * Example usage:
- * <pre><code>
-Ext.create('Ext.button.Cycle', {
-    showText: true,
-    prependText: 'View as ',
-    renderTo: Ext.getBody(),
-    menu: {
-        id: 'view-type-menu',
-        items: [{
-            text:'text only',
-            iconCls:'view-text',
-            checked:true
-        },{
-            text:'HTML',
-            iconCls:'view-html'
-        }]
-    },
-    changeHandler:function(cycleBtn, activeItem){
-        Ext.Msg.alert('Change View', activeItem.text);
-    }
-});
-</code></pre>
+ * button displays the dropdown menu just like a normal SplitButton.  Example usage:
+ *
+ *     @example
+ *     Ext.create('Ext.button.Cycle', {
+ *         showText: true,
+ *         prependText: 'View as ',
+ *         renderTo: Ext.getBody(),
+ *         menu: {
+ *             id: 'view-type-menu',
+ *             items: [{
+ *                 text: 'text only',
+ *                 iconCls: 'view-text',
+ *                 checked: true
+ *             },{
+ *                 text: 'HTML',
+ *                 iconCls: 'view-html'
+ *             }]
+ *         },
+ *         changeHandler: function(cycleBtn, activeItem) {
+ *             Ext.Msg.alert('Change View', activeItem.text);
+ *         }
+ *     });
  */
 Ext.define('Ext.button.Cycle', {
 
@@ -55,34 +51,40 @@ Ext.define('Ext.button.Cycle', {
     /* End Definitions */
 
     /**
-     * @cfg {Array} items <p>Deprecated as of 4.0. Use the {@link #menu} config instead. All menu items will be created
-     * as {@link Ext.menu.CheckItem CheckItem}s.</p>
-     * <p>An array of {@link Ext.menu.CheckItem} <b>config</b> objects to be used when creating the
-     * button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})
+     * @cfg {Object[]} items
+     * An array of {@link Ext.menu.CheckItem} **config** objects to be used when creating the button's menu items (e.g.,
+     * `{text:'Foo', iconCls:'foo-icon'}`)
+     * 
+     * @deprecated 4.0 Use the {@link #menu} config instead. All menu items will be created as
+     * {@link Ext.menu.CheckItem CheckItems}.
      */
     /**
-     * @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false).
-     * The Button will show its configured {@link #text} if this. config is omitted.
+     * @cfg {Boolean} [showText=false]
+     * True to display the active item's text as the button text. The Button will show its
+     * configured {@link #text} if this config is omitted.
      */
     /**
-     * @cfg {String} prependText A static string to prepend before the active item's text when displayed as the
-     * button's text (only applies when showText = true, defaults to '')
+     * @cfg {String} [prependText='']
+     * A static string to prepend before the active item's text when displayed as the button's text (only applies when
+     * showText = true).
      */
     /**
-     * @cfg {Function} changeHandler A callback function that will be invoked each time the active menu
-     * item in the button's menu has changed.  If this callback is not supplied, the SplitButton will instead
-     * fire the {@link #change} event on active item change.  The changeHandler function will be called with the
-     * following argument list: (SplitButton this, Ext.menu.CheckItem item)
+     * @cfg {Function} changeHandler
+     * A callback function that will be invoked each time the active menu item in the button's menu has changed. If this
+     * callback is not supplied, the SplitButton will instead fire the {@link #change} event on active item change. The
+     * changeHandler function will be called with the following argument list: (SplitButton this, Ext.menu.CheckItem
+     * item)
      */
     /**
-     * @cfg {String} forceIcon A css class which sets an image to be used as the static icon for this button.  This
-     * icon will always be displayed regardless of which item is selected in the dropdown list.  This overrides the 
-     * default behavior of changing the button's icon to match the selected item's icon on change.
+     * @cfg {String} forceIcon
+     * A css class which sets an image to be used as the static icon for this button. This icon will always be displayed
+     * regardless of which item is selected in the dropdown list. This overrides the default behavior of changing the
+     * button's icon to match the selected item's icon on change.
      */
     /**
-     * @property menu
-     * @type Menu
-     * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices.
+     * @property {Ext.menu.Menu} menu
+     * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the
+     * available choices.
      */
 
     // private
@@ -103,7 +105,7 @@ Ext.define('Ext.button.Cycle', {
     /**
      * Sets the button's active menu item.
      * @param {Ext.menu.CheckItem} item The item to activate
-     * @param {Boolean} suppressEvent True to prevent the button's change event from firing (defaults to false)
+     * @param {Boolean} [suppressEvent=false] True to prevent the button's change event from firing.
      */
     setActiveItem: function(item, suppressEvent) {
         var me = this;
@@ -149,9 +151,9 @@ Ext.define('Ext.button.Cycle', {
         me.addEvents(
             /**
              * @event change
-             * Fires after the button's active menu item has changed.  Note that if a {@link #changeHandler} function
-             * is set on this CycleButton, it will be called instead on active item change and this change event will
-             * not be fired.
+             * Fires after the button's active menu item has changed. Note that if a {@link #changeHandler} function is
+             * set on this CycleButton, it will be called instead on active item change and this change event will not
+             * be fired.
              * @param {Ext.button.Cycle} this
              * @param {Ext.menu.CheckItem} item The menu item that was selected
              */
@@ -204,9 +206,9 @@ Ext.define('Ext.button.Cycle', {
     },
 
     /**
-     * This is normally called internally on button click, but can be called externally to advance the button's
-     * active item programmatically to the next one in the menu.  If the current item is the last one in the menu
-     * the active item will be set to the first item in the menu.
+     * This is normally called internally on button click, but can be called externally to advance the button's active
+     * item programmatically to the next one in the menu. If the current item is the last one in the menu the active
+     * item will be set to the first item in the menu.
      */
     toggleSelected: function() {
         var me = this,