Upgrade to ExtJS 4.0.2 - Released 06/09/2011

[extjs.git] / src / util / Grouper.js

diff --git a/src/util/Grouper.js b/src/util/Grouper.js
index d846300..a30f1bf 100644 (file)
--- a/src/util/Grouper.js
+++ b/src/util/Grouper.js
@@ -1,6 +1,25 @@
+/*
+
+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.
+
+*/
 /**
  * @class Ext.util.Grouper
  * @extends Ext.util.Sorter
+
+Represents a single grouper that can be applied to a Store. The grouper works
+in the same fashion as the {@link Ext.util.Sorter}.
+
+ * @markdown
  */
  
 Ext.define('Ext.util.Grouper', {
@@ -12,11 +31,11 @@ Ext.define('Ext.util.Grouper', {
     /* End Definitions */
 
     /**
-     * Function description
+     * Returns the value for grouping to be used.
      * @param {Ext.data.Model} instance The Model instance
      * @return {String} The group string for this model
      */
     getGroupString: function(instance) {
         return instance.get(this.property);
     }
-});
\ No newline at end of file
+});