You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by mi...@apache.org on 2016/11/09 13:51:32 UTC

git commit: [flex-sdk] [refs/heads/develop] - FLEX-34880 Added an asdoc recommendation that developers use Sort and SortField as immutable objects, although the current API allows for mutability.

Repository: flex-sdk
Updated Branches:
  refs/heads/develop 286a0ca94 -> 4ead7712d


FLEX-34880
Added an asdoc recommendation that developers use Sort and SortField as immutable objects, although the current API allows for mutability.


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

Branch: refs/heads/develop
Commit: 4ead7712d68ef40449f58d031031b305f38b5739
Parents: 286a0ca
Author: Mihai Chira <mi...@apache.org>
Authored: Wed Nov 9 14:51:10 2016 +0100
Committer: Mihai Chira <mi...@apache.org>
Committed: Wed Nov 9 14:51:10 2016 +0100

----------------------------------------------------------------------
 frameworks/projects/framework/src/mx/collections/Sort.as      | 5 +++++
 frameworks/projects/framework/src/mx/collections/SortField.as | 5 +++++
 frameworks/projects/spark/src/spark/collections/Sort.as       | 5 +++++
 frameworks/projects/spark/src/spark/collections/SortField.as  | 5 +++++
 4 files changed, 20 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/4ead7712/frameworks/projects/framework/src/mx/collections/Sort.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/framework/src/mx/collections/Sort.as b/frameworks/projects/framework/src/mx/collections/Sort.as
index 7e2e82c..38acab8 100644
--- a/frameworks/projects/framework/src/mx/collections/Sort.as
+++ b/frameworks/projects/framework/src/mx/collections/Sort.as
@@ -95,6 +95,11 @@ package mx.collections
  *  sorting for strings.  For this type of sorting please see the 
  *  <code>spark.collections.Sort</code> and 
  *  <code>spark.collections.SortField</code> classes.</p>
+ *
+ *  Note: to prevent problems like
+ *  <a href="https://issues.apache.org/jira/browse/FLEX-34853">FLEX-34853</a>
+ *  it is recommended to use SortField
+ *  instances as immutable objects (by not changing their state).
  * 
  *  @mxml
  *

http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/4ead7712/frameworks/projects/framework/src/mx/collections/SortField.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/framework/src/mx/collections/SortField.as b/frameworks/projects/framework/src/mx/collections/SortField.as
index a465656..824d98d 100644
--- a/frameworks/projects/framework/src/mx/collections/SortField.as
+++ b/frameworks/projects/framework/src/mx/collections/SortField.as
@@ -72,6 +72,11 @@ package mx.collections
  *  <code>spark.collections.Sort</code> and
  *  <code>spark.collections.SortField</code> classes.</p>
  *
+ *  Note: to prevent problems like
+ *  <a href="https://issues.apache.org/jira/browse/FLEX-34853">FLEX-34853</a>
+ *  it is recommended to use SortField
+ *  instances as immutable objects (by not changing their state).
+ *
  *  @mxml
  *
  *  <p>The <code>&lt;mx:SortField&gt;</code> tag has the following attributes:</p>

http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/4ead7712/frameworks/projects/spark/src/spark/collections/Sort.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/spark/src/spark/collections/Sort.as b/frameworks/projects/spark/src/spark/collections/Sort.as
index 0f31834..891da49 100644
--- a/frameworks/projects/spark/src/spark/collections/Sort.as
+++ b/frameworks/projects/spark/src/spark/collections/Sort.as
@@ -160,6 +160,11 @@ package spark.collections
  *  UIComponent's <code>addStyleClient()</code> method.
  *  </li>
  *  </ul>
+ *
+ *  Note: to prevent problems like
+ *  <a href="https://issues.apache.org/jira/browse/FLEX-34853">FLEX-34853</a>
+ *  it is recommended to use SortField
+ *  instances as immutable objects (by not changing their state).
  *  
  *  @mxml
  *

http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/4ead7712/frameworks/projects/spark/src/spark/collections/SortField.as
----------------------------------------------------------------------
diff --git a/frameworks/projects/spark/src/spark/collections/SortField.as b/frameworks/projects/spark/src/spark/collections/SortField.as
index 760b725..5b730a2 100644
--- a/frameworks/projects/spark/src/spark/collections/SortField.as
+++ b/frameworks/projects/spark/src/spark/collections/SortField.as
@@ -129,6 +129,11 @@ package spark.collections
  *  UIComponent's <code>addStyleClient()</code> method.
  *  </li>
  *  </ul>
+ *
+ *  Note: to prevent problems like
+ *  <a href="https://issues.apache.org/jira/browse/FLEX-34853">FLEX-34853</a>
+ *  it is recommended to use SortField
+ *  instances as immutable objects (by not changing their state).
  *  
  *  @mxml
  *