flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mkess...@apache.org
Subject git commit: [flex-sdk] [refs/heads/develop] - Updated ASDOC comments for the GridColumn.sortCompareType to be more descriptive.
Date Sat, 16 Nov 2013 23:59:26 GMT
Updated Branches:
  refs/heads/develop 78eab008d -> 9f3a8015b


Updated ASDOC comments for the GridColumn.sortCompareType to be more descriptive.


Project: http://git-wip-us.apache.org/repos/asf/flex-sdk/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-sdk/commit/9f3a8015
Tree: http://git-wip-us.apache.org/repos/asf/flex-sdk/tree/9f3a8015
Diff: http://git-wip-us.apache.org/repos/asf/flex-sdk/diff/9f3a8015

Branch: refs/heads/develop
Commit: 9f3a8015b588064716814fb679035fe3191f0776
Parents: 78eab00
Author: Mark Kessler <KesslerConsulting@gmail.com>
Authored: Sat Nov 16 18:58:19 2013 -0500
Committer: Mark Kessler <KesslerConsulting@gmail.com>
Committed: Sat Nov 16 18:58:19 2013 -0500

----------------------------------------------------------------------
 .../src/spark/components/gridClasses/GridColumn.as   | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/9f3a8015/frameworks/projects/spark/src/spark/components/gridClasses/GridColumn.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/spark/src/spark/components/gridClasses/GridColumn.as b/frameworks/projects/spark/src/spark/components/gridClasses/GridColumn.as
index 642b8b8..ff7b298 100644
--- a/frameworks/projects/spark/src/spark/components/gridClasses/GridColumn.as
+++ b/frameworks/projects/spark/src/spark/components/gridClasses/GridColumn.as
@@ -1451,7 +1451,20 @@ public class GridColumn extends EventDispatcher
     private var _sortCompareType:String;
 
     /**
-     *  @inheritDoc
+	 *  The sortCompareType defines the valid constant values for the 
+	 *  <code>sortCompareType</code> property of the <code>SortField</code>
and <code>GridColumn</code>.
+	 *  
+	 *  <p>Use the constants in ActionsScript, as the following example shows:</p>
+	 *  <pre>
+	 *    column.sortCompareType = SortFieldCompareTypes.NUMERIC;
+	 *  </pre>
+	 *
+	 *  <p>In MXML, use the String value of the constants, as the following example shows:</p>
+	 *  <pre>
+	 *    &lt;s:GridColumn sortCompareType="numeric" /&gt; 
+	 *  </pre>
+	 * 
+     *  @see spark.collections.SortFieldCompareTypes
      *
      *  @langversion 3.0
      *  @playerversion Flash 11.8


Mime
View raw message