[embjopr-commits] EMBJOPR SVN: r237 - trunk/jsfunit/src/test/java/org/jboss/jopr/jsfunit/util.

[embjopr-commits at lists.jboss.org]

Author: ozizka at redhat.com
Date: 2009-03-17 15:32:30 -0400 (Tue, 17 Mar 2009)
New Revision: 237

Modified:
   trunk/jsfunit/src/test/java/org/jboss/jopr/jsfunit/util/EmbJoprTestToolkit.java
Log:
Docs updated.

Modified: trunk/jsfunit/src/test/java/org/jboss/jopr/jsfunit/util/EmbJoprTestToolkit.java
===================================================================
--- trunk/jsfunit/src/test/java/org/jboss/jopr/jsfunit/util/EmbJoprTestToolkit.java	2009-03-17 18:41:34 UTC (rev 236)
+++ trunk/jsfunit/src/test/java/org/jboss/jopr/jsfunit/util/EmbJoprTestToolkit.java	2009-03-17 19:32:30 UTC (rev 237)
@@ -160,6 +160,8 @@
 		 * @throws java.lang.Exception  Whatever exception is thrown from the isTrue() method.
 		 * @throws org.jboss.jopr.jsfunit.exceptions.EmbJoprTestException
 		 *         when max number of retries was reached.
+		 * 
+		 * @see EMBJOPR-92.
 		 */
 		public void waitUntilLoaded( int msInterval, int retries ) throws Exception {
 			final NavTree self = this;
@@ -273,6 +275,9 @@
     }
 
 
+		/**
+		 * Returns true if the JS function object 'Tree.Item' is initialized.
+		 */
 		public boolean isReady(){
 			Object obj = getJavaScriptObject("Tree.Item");
 			if( null == obj ) return false;
@@ -281,6 +286,16 @@
 			return true;
 		}
 
+
+		/**
+		 * Waits until the JS function object 'Tree.Item' is initialized.
+		 * @param msInterval  Millisecons between tries.
+		 * @param retries     Number of tries.
+		 * @throws org.jboss.jopr.jsfunit.exceptions.EmbJoprTestException
+		 *		wrapping whatever exception happens when checking the JS object's value.
+		 *
+		 * @see https://jira.jboss.org/jira/browse/EMBJOPR-101
+		 */
 		public void waitUntilReady( int msInterval, int retries ) throws EmbJoprTestException {
 			final NavTree self = this;
 			try {