Upgrade to ExtJS 4.0.2 - Released 06/09/2011

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

diff --git a/src/data/ArrayStore.js b/src/data/ArrayStore.js
index 718dbce..dbce070 100644 (file)
--- a/src/data/ArrayStore.js
+++ b/src/data/ArrayStore.js
@@ -1,57 +1,60 @@
+/*
+
+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.ArrayStore
- * @extends Ext.data.Store
- * @ignore
  *
- * <p>Small helper class to make creating {@link Ext.data.Store}s from Array data easier.
- * An ArrayStore will be automatically configured with a {@link Ext.data.reader.Array}.</p>
+ * Small helper class to make creating {@link Ext.data.Store}s from Array data easier. An ArrayStore will be
+ * automatically configured with a {@link Ext.data.reader.Array}.
  *
- * <p>A store configuration would be something like:</p>
-<pre><code>
-var store = new Ext.data.ArrayStore({
-    // store configs
-    autoDestroy: true,
-    storeId: 'myStore',
-    // reader configs
-    idIndex: 0,
-    fields: [
-       'company',
-       {name: 'price', type: 'float'},
-       {name: 'change', type: 'float'},
-       {name: 'pctChange', type: 'float'},
-       {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
-    ]
-});
-</code></pre>
- * <p>This store is configured to consume a returned object of the form:
-<pre><code>
-var myData = [
-    ['3m Co',71.72,0.02,0.03,'9/1 12:00am'],
-    ['Alcoa Inc',29.01,0.42,1.47,'9/1 12:00am'],
-    ['Boeing Co.',75.43,0.53,0.71,'9/1 12:00am'],
-    ['Hewlett-Packard Co.',36.53,-0.03,-0.08,'9/1 12:00am'],
-    ['Wal-Mart Stores, Inc.',45.45,0.73,1.63,'9/1 12:00am']
-];
-</code></pre>
-*
- * <p>An object literal of this form could also be used as the {@link #data} config option.</p>
+ * A store configuration would be something like:
+ *
+ *     var store = Ext.create('Ext.data.ArrayStore', {
+ *         // store configs
+ *         autoDestroy: true,
+ *         storeId: 'myStore',
+ *         // reader configs
+ *         idIndex: 0,
+ *         fields: [
+ *            'company',
+ *            {name: 'price', type: 'float'},
+ *            {name: 'change', type: 'float'},
+ *            {name: 'pctChange', type: 'float'},
+ *            {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
+ *         ]
+ *     });
+ *
+ * This store is configured to consume a returned object of the form:
  *
- * <p><b>*Note:</b> Although not listed here, this class accepts all of the configuration options of
- * <b>{@link Ext.data.reader.Array ArrayReader}</b>.</p>
+ *     var myData = [
+ *         ['3m Co',71.72,0.02,0.03,'9/1 12:00am'],
+ *         ['Alcoa Inc',29.01,0.42,1.47,'9/1 12:00am'],
+ *         ['Boeing Co.',75.43,0.53,0.71,'9/1 12:00am'],
+ *         ['Hewlett-Packard Co.',36.53,-0.03,-0.08,'9/1 12:00am'],
+ *         ['Wal-Mart Stores, Inc.',45.45,0.73,1.63,'9/1 12:00am']
+ *     ];
  *
- * @constructor
- * @param {Object} config
- * @xtype arraystore
+ * An object literal of this form could also be used as the {@link #data} config option.
+ *
+ * **Note:** Although not listed here, this class accepts all of the configuration options of
+ * **{@link Ext.data.reader.Array ArrayReader}**.
  */
 Ext.define('Ext.data.ArrayStore', {
     extend: 'Ext.data.Store',
     alias: 'store.array',
     uses: ['Ext.data.reader.Array'],
 
-    /**
-     * @cfg {Ext.data.DataReader} reader @hide
-     */
     constructor: function(config) {
         config = config || {};
 
@@ -85,3 +88,4 @@ Ext.define('Ext.data.ArrayStore', {
     Ext.data.SimpleStore = Ext.data.ArrayStore;
     // Ext.reg('simplestore', Ext.data.SimpleStore);
 });
+