Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Base3.html
index ed5abbe..245f40e 100644 (file)
@@ -69,17 +69,10 @@ var Base = Ext.Base = function() {};
          *
          * @type Class
          * @protected
-         * @markdown
          */
         self: Base,
 
-<span id='Ext-Base-method-constructor'>        /**
-</span>         * Default constructor, simply returns `this`
-         *
-         * @constructor
-         * @protected
-         * @return {Object} this
-         */
+        // Default constructor, simply returns `this`
         constructor: function() {
             return this;
         },
@@ -110,7 +103,6 @@ var Base = Ext.Base = function() {};
          * @protected
          * @param {Object} config
          * @return {Object} mixins The mixin prototypes as key - value pairs
-         * @markdown
          */
         initConfig: function(config) {
             if (!this.$configInited) {
@@ -184,7 +176,6 @@ var Base = Ext.Base = function() {};
          * @param {Array/Arguments} args The arguments, either an array or the `arguments` object
          * from the current method, for example: `this.callParent(arguments)`
          * @return {Mixed} Returns the result from the superclass' method
-         * @markdown
          */
         callParent: function(args) {
             var method = this.callParent.caller,
@@ -280,7 +271,6 @@ var Base = Ext.Base = function() {};
          *
          * @protected
          * @return {Class}
-         * @markdown
          */
         statics: function() {
             var method = this.statics.caller,
@@ -322,7 +312,6 @@ var Base = Ext.Base = function() {};
          *
          * @param {Array/Arguments} args The arguments, either an array or the `arguments` object
          * @return {Mixed} Returns the result after calling the overridden method
-         * @markdown
          */
         callOverridden: function(args) {
             var method = this.callOverridden.caller;
@@ -354,7 +343,7 @@ var Base = Ext.Base = function() {};
 
     // These static properties will be copied to every newly created class with {@link Ext#define}
     Ext.apply(Ext.Base, {
-<span id='Ext-Base-property-create'>        /**
+<span id='Ext-Base-method-create'>        /**
 </span>         * Create a new instance of this Class.
          *
          *     Ext.define('My.cool.Class', {
@@ -365,10 +354,10 @@ var Base = Ext.Base = function() {};
          *         someConfig: true
          *     });
          *
-         * @property create
+         * All parameters are passed to the constructor of the class.
+         *
+         * @return {Object} the created instance.
          * @static
-         * @type Function
-         * @markdown
          */
         create: function() {
             return Ext.create.apply(Ext, [this].concat(Array.prototype.slice.call(arguments, 0)));
@@ -413,7 +402,7 @@ var Base = Ext.Base = function() {};
             this.prototype[name] = fn;
         },
 
-<span id='Ext-Base-property-addStatics'>        /**
+<span id='Ext-Base-method-addStatics'>        /**
 </span>         * Add / override static properties of this class.
          *
          *     Ext.define('My.cool.Class', {
@@ -426,11 +415,9 @@ var Base = Ext.Base = function() {};
          *         method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
          *     });
          *
-         * @property addStatics
-         * @static
-         * @type Function
          * @param {Object} members
-         * @markdown
+         * @return {Ext.Base} this
+         * @static
          */
         addStatics: function(members) {
             for (var name in members) {
@@ -442,7 +429,7 @@ var Base = Ext.Base = function() {};
             return this;
         },
 
-<span id='Ext-Base-property-implement'>        /**
+<span id='Ext-Base-method-implement'>        /**
 </span>         * Add methods / properties to the prototype of this class.
          *
          *     Ext.define('My.awesome.Cat', {
@@ -460,11 +447,8 @@ var Base = Ext.Base = function() {};
          *      var kitty = new My.awesome.Cat;
          *      kitty.meow();
          *
-         * @property implement
-         * @static
-         * @type Function
          * @param {Object} members
-         * @markdown
+         * @static
          */
         implement: function(members) {
             var prototype = this.prototype,
@@ -506,7 +490,7 @@ var Base = Ext.Base = function() {};
             }
         },
 
-<span id='Ext-Base-property-borrow'>        /**
+<span id='Ext-Base-method-borrow'>        /**
 </span>         * Borrow another class' members to the prototype of this class.
          *
          *     Ext.define('Bank', {
@@ -527,13 +511,11 @@ var Base = Ext.Base = function() {};
          *     alert(steve.money); // alerts '$$$'
          *     steve.printMoney(); // alerts '$$$$$$$'
          *
-         * @property borrow
-         * @static
-         * @type Function
          * @param {Ext.Base} fromClass The class to borrow members from
          * @param {Array/String} members The names of the members to borrow
          * @return {Ext.Base} this
-         * @markdown
+         * @static
+         * @private
          */
         borrow: function(fromClass, members) {
             var fromPrototype = fromClass.prototype,
@@ -550,7 +532,7 @@ var Base = Ext.Base = function() {};
             return this;
         },
 
-<span id='Ext-Base-property-override'>        /**
+<span id='Ext-Base-method-override'>        /**
 </span>         * Override prototype members of this class. Overridden methods can be invoked via
          * {@link Ext.Base#callOverridden}
          *
@@ -578,12 +560,9 @@ var Base = Ext.Base = function() {};
          *                               // alerts &quot;I'm a cat!&quot;
          *                               // alerts &quot;Meeeeoooowwww&quot;
          *
-         * @property override
-         * @static
-         * @type Function
          * @param {Object} members
          * @return {Ext.Base} this
-         * @markdown
+         * @static
          */
         override: function(members) {
             var prototype = this.prototype,
@@ -678,13 +657,12 @@ var Base = Ext.Base = function() {};
          *     My.cool.Class.getName(); // 'My.cool.Class'
          *
          * @return {String} className
-         * @markdown
          */
         getName: function() {
             return Ext.getClassName(this);
         },
 
-<span id='Ext-Base-property-createAlias'>        /**
+<span id='Ext-Base-method-createAlias'>        /**
 </span>         * Create aliases for existing prototype methods. Example:
          *
          *     Ext.define('My.cool.Class', {
@@ -705,13 +683,11 @@ var Base = Ext.Base = function() {};
          *
          *     test.method5(); // test.method3() -&gt; test.method1()
          *
-         * @property createAlias
-         * @static
-         * @type Function
          * @param {String/Object} alias The new method name, or an object to set multiple aliases. See
          * {@link Ext.Function#flexSetter flexSetter}
          * @param {String/Object} origin The original method name
-         * @markdown
+         * @static
+         * @method
          */
         createAlias: flexSetter(function(alias, origin) {
             this.prototype[alias] = this.prototype[origin];