JAL-1270 avoid overwriting .jalview_properties with test service urls

[jalview.git] / test / jalview / ws / jabaws / JalviewJabawsTestUtils.java

diff --git a/test/jalview/ws/jabaws/JalviewJabawsTestUtils.java b/test/jalview/ws/jabaws/JalviewJabawsTestUtils.java
index 4550fe8..4414782 100644 (file)
--- a/test/jalview/ws/jabaws/JalviewJabawsTestUtils.java
+++ b/test/jalview/ws/jabaws/JalviewJabawsTestUtils.java
@@ -60,6 +60,20 @@ public class JalviewJabawsTestUtils
     return getJabawsDiscoverer(true);
   }
 
+  /**
+   * Returns a service discoverer that queries localhost and compbio urls.
+   * <p>
+   * If using this method, be sure to have read-only Jalview properties, to
+   * avoid writing the test urls to .jalview_properties. This can be done by
+   * either
+   * <ul>
+   * <li>running Jalview main with arguments -props propFileName</li>
+   * <li>calling Cache.loadProperties(filename)</li>
+   * <ul>
+   * 
+   * @param localhost
+   * @return
+   */
   public static Jws2Discoverer getJabawsDiscoverer(boolean localhost)
   {
     jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer