From 9c486010c1dbe10a9d9c39235f39761286ee843d Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Wed, 25 Apr 2007 21:24:35 +0000
Subject: [PATCH] [184095] update docs for
 SystemWidgetHelpers.sortSystemTypesByLabel()

---
 .../UI/org/eclipse/rse/ui/SystemWidgetHelpers.java       | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/SystemWidgetHelpers.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/SystemWidgetHelpers.java
index bd55582f0b4..956cec26b64 100644
--- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/SystemWidgetHelpers.java
+++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/SystemWidgetHelpers.java
@@ -1137,7 +1137,14 @@ public class SystemWidgetHelpers {
 
 	/**
 	 * Sorts the given array of systemTypes in ascending order by system
-	 * type label. 
+	 * type label.
+	 *  
+	 * Note that this method sorts the array in place, so clients are 
+	 * responsible for creating a copy of the array when needed. In the
+	 * future, this may sort using an internationalization enabled
+	 * collate algorithm for translated labels (currently, normal
+	 * String compare is used).
+	 * 
 	 * @param systemTypes list of system types to sort
 	 */
 	public static void sortSystemTypesByLabel(IRSESystemType[] systemTypes) {