Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / src / data / ResultSet.js

diff --git a/src/data/ResultSet.js b/src/data/ResultSet.js
index c696c87..4f533af 100644 (file)
--- a/src/data/ResultSet.js
+++ b/src/data/ResultSet.js
@@ -14,56 +14,55 @@ If you are unsure which license is appropriate for your use, please contact the
 */
 /**
  * @author Ed Spencer
 */
 /**
  * @author Ed Spencer

- * @class Ext.data.ResultSet
- * @extends Object
- * 
- * <p>Simple wrapper class that represents a set of records returned by a Proxy.</p>
+ *
+ * Simple wrapper class that represents a set of records returned by a Proxy.

  */
 Ext.define('Ext.data.ResultSet', {
     /**
      * @cfg {Boolean} loaded
      * True if the records have already been loaded. This is only meaningful when dealing with
  */
 Ext.define('Ext.data.ResultSet', {
     /**
      * @cfg {Boolean} loaded
      * True if the records have already been loaded. This is only meaningful when dealing with

-     * SQL-backed proxies
+     * SQL-backed proxies.

      */
     loaded: true,
      */
     loaded: true,

-    
+

     /**
      * @cfg {Number} count
     /**
      * @cfg {Number} count

-     * The number of records in this ResultSet. Note that total may differ from this number
+     * The number of records in this ResultSet. Note that total may differ from this number.

      */
     count: 0,
      */
     count: 0,

-    
+

     /**
      * @cfg {Number} total
      * The total number of records reported by the data source. This ResultSet may form a subset of
     /**
      * @cfg {Number} total
      * The total number of records reported by the data source. This ResultSet may form a subset of

-     * those records (see count)
+     * those records (see {@link #count}).

      */
     total: 0,
      */
     total: 0,

-    
+

     /**
      * @cfg {Boolean} success
     /**
      * @cfg {Boolean} success

-     * True if the ResultSet loaded successfully, false if any errors were encountered
+     * True if the ResultSet loaded successfully, false if any errors were encountered.

      */
     success: false,
      */
     success: false,

-    
+

     /**
     /**

-     * @cfg {Array} records The array of record instances. Required
+     * @cfg {Ext.data.Model[]} records (required)
+     * The array of record instances.

      */
 
     /**
      * Creates the resultSet
      */
 
     /**
      * Creates the resultSet

-     * @param {Object} config (optional) Config object.
+     * @param {Object} [config] Config object.

      */
     constructor: function(config) {
         Ext.apply(this, config);
      */
     constructor: function(config) {
         Ext.apply(this, config);

-        
+

         /**
         /**

-         * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead
-         * @property totalRecords
-         * @type Mixed
+         * @property {Number} totalRecords
+         * Copy of this.total.
+         * @deprecated Will be removed in Ext JS 5.0. Use {@link #total} instead.

          */
         this.totalRecords = this.total;
          */
         this.totalRecords = this.total;

-        
+

         if (config.count === undefined) {
             this.count = this.records.length;
         }
         if (config.count === undefined) {
             this.count = this.records.length;
         }