Bug 1253381 - Add JavascriptTest javadoc to explain test. r=sebastian draft
authorMichael Comella <michael.l.comella@gmail.com>
Thu, 03 Mar 2016 13:33:42 -0800
changeset 336602 66f0881e7b7b94f719a8337112711fffadf894bb
parent 336601 49384ca95cecea2c9fca312957f8775c034da3a0
child 336603 7edde4fa1fbb6a73e4e6eac358593b731afbc167
push id12141
push usermichael.l.comella@gmail.com
push dateThu, 03 Mar 2016 21:39:01 +0000
reviewerssebastian
bugs1253381
milestone47.0a1
Bug 1253381 - Add JavascriptTest javadoc to explain test. r=sebastian MozReview-Commit-ID: BL8WU3m2U6v
mobile/android/tests/browser/robocop/src/org/mozilla/gecko/tests/JavascriptTest.java
--- a/mobile/android/tests/browser/robocop/src/org/mozilla/gecko/tests/JavascriptTest.java
+++ b/mobile/android/tests/browser/robocop/src/org/mozilla/gecko/tests/JavascriptTest.java
@@ -6,16 +6,23 @@ package org.mozilla.gecko.tests;
 
 import org.json.JSONObject;
 import org.mozilla.gecko.Actions;
 import org.mozilla.gecko.tests.helpers.JavascriptBridge;
 import org.mozilla.gecko.tests.helpers.JavascriptMessageParser;
 
 import android.util.Log;
 
+/**
+ * Extended to test stand-alone Javascript in automation. If you're looking to test JS interactions
+ * with Java, see {@link JavascriptBridgeTest}.
+ *
+ * There are also other tests that run stand-alone javascript but are more difficult for the mobile
+ * team to run (e.g. xpcshell).
+ */
 public class JavascriptTest extends BaseTest {
     private static final String LOGTAG = "JavascriptTest";
     private static final String EVENT_TYPE = JavascriptBridge.EVENT_TYPE;
 
     // Calculate these once, at initialization. isLoggable is too expensive to
     // have in-line in each log call.
     private static final boolean logDebug   = Log.isLoggable(LOGTAG, Log.DEBUG);
     private static final boolean logVerbose = Log.isLoggable(LOGTAG, Log.VERBOSE);