X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/source/AbstractPlugin.html diff --git a/docs/source/AbstractPlugin.html b/docs/source/AbstractPlugin.html index 6a65c7a1..407c5275 100644 --- a/docs/source/AbstractPlugin.html +++ b/docs/source/AbstractPlugin.html @@ -3,8 +3,8 @@ The source code - - + + @@ -16,20 +16,23 @@
/**
- * @class Ext.AbstractPlugin
- * @extends Object
+ * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
  *
- * <p>The AbstractPlugin class is the base class from which user-implemented plugins should inherit.</p>
- * <p>This class defines the essential API of plugins as used by Components by defining the following methods:</p>
- * <ul>
- * <li><code>init</code> : The plugin initialization method which the owning Component calls at Component initialization
- * time.<div class="sub-desc"><p>The Component passes itself as the sole parameter.</p><p>Subclasses should set up bidirectional
- * links between the plugin and its client Component here.</p></div></li>
- * <li><code>destroy</code> : The plugin cleanup method which the owning Component calls at Component destruction time.<div class="sub-desc">Use
- * this method to break links between the plugin and the Component and to free any allocated resources.</div></li>
- * <li><code>enable</code> : The base implementation just sets the plugin's <code>disabled</code> flag to <code>false</code><div class="sub-desc"></div></li>
- * <li><code>disable</code> : The base implementation just sets the plugin's <code>disabled</code> flag to <code>true</code><div class="sub-desc"></div></li>
- * </ul>
+ * This class defines the essential API of plugins as used by Components by defining the following methods:
+ *
+ *   - `init` : The plugin initialization method which the owning Component calls at Component initialization time.
+ *
+ *     The Component passes itself as the sole parameter.
+ *
+ *     Subclasses should set up bidirectional links between the plugin and its client Component here.
+ *
+ *   - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time.
+ *
+ *     Use this method to break links between the plugin and the Component and to free any allocated resources.
+ *
+ *   - `enable` : The base implementation just sets the plugin's `disabled` flag to `false`
+ *
+ *   - `disable` : The base implementation just sets the plugin's `disabled` flag to `true`
  */
 Ext.define('Ext.AbstractPlugin', {
     disabled: false,
@@ -48,32 +51,37 @@ Ext.define('Ext.AbstractPlugin', {
     },
 
     /**
-     * <p>The init method is invoked after {@link Ext.Component#initComponent initComponent} has been run for the client Component.</p>
-     * <p>The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
-     * links between the plugin and its client Component in their own implementation of this method.</p>
-     * @param {Component} client The client Component which owns this plugin.
-     * @method
+     * @method
+     * The init method is invoked after initComponent method has been run for the client Component.
+     *
+     * The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
+     * links between the plugin and its client Component in their own implementation of this method.
+     * @param {Ext.Component} client The client Component which owns this plugin.
      */
     init: Ext.emptyFn,
 
     /**
-     * <p>The destroy method is invoked by the owning Component at the time the Component is being destroyed.</p>
-     * <p>The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.</p>
-     * @method
+     * @method
+     * The destroy method is invoked by the owning Component at the time the Component is being destroyed.
+     *
+     * The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of
+     * this method.
      */
     destroy: Ext.emptyFn,
 
     /**
-     * <p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>false</code></p>
-     * <p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>
+     * The base implementation just sets the plugin's `disabled` flag to `false`
+     *
+     * Plugin subclasses which need more complex processing may implement an overriding implementation.
      */
     enable: function() {
         this.disabled = false;
     },
 
     /**
-     * <p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>true</code></p>
-     * <p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>
+     * The base implementation just sets the plugin's `disabled` flag to `true`
+     *
+     * Plugin subclasses which need more complex processing may implement an overriding implementation.
      */
     disable: function() {
         this.disabled = true;