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 74fc5ec..4f533af 100644 (file)
--- a/src/data/ResultSet.js
+++ b/src/data/ResultSet.js
@@ -1,56 +1,70 @@
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
 /**
  * @author Ed Spencer
- * @class Ext.data.ResultSet
- * @extends Object
- * 
- * <p>Simple wrapper class that represents a set of records returned by a Proxy.</p>
- * 
- * @constructor
- * Creates the new ResultSet
+ *
+ * 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
-     * SQL-backed proxies
+     * SQL-backed proxies.
      */
     loaded: true,
-    
+
     /**
      * @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,
-    
+
     /**
      * @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,
-    
+
     /**
      * @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,
-    
+
     /**
-     * @cfg {Array} records The array of record instances. Required
+     * @cfg {Ext.data.Model[]} records (required)
+     * The array of record instances.
      */
 
+    /**
+     * Creates the resultSet
+     * @param {Object} [config] Config object.
+     */
     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;
-        
+
         if (config.count === undefined) {
             this.count = this.records.length;
         }
     }
-});
\ No newline at end of file
+});