Javadoc

gk5885 · gk5885 · commit c1c33066dd80 · 2014-01-31T16:24:57.000-06:00
diff --git a/src/main/java/com/google/testing/compile/CompilationRule.java b/src/main/java/com/google/testing/compile/CompilationRule.java
@@ -39,8 +39,8 @@
 import javax.lang.model.util.Types;
 
 /**
- * A {@link JUnit4} {@link Rule} that executes tests such that an instances of {@link Elements}
- * and {@link Types} are available during execution.
+ * A {@link JUnit4} {@link Rule} that executes tests such that a instances of {@link Elements} and
+ * {@link Types} are available during execution.
  *
  * <p>To use this rule in a test, just add the following field: <pre>   {@code
  *   @Rule public CompilationRule compilationRule = new CompilationRule();}
@@ -99,11 +99,21 @@ public boolean process(Set<? extends TypeElement> annotations,
     };
   }
 
+  /**
+   * Returns the {@link Elements} instance associated with the current execution of the rule.
+   *
+   * @throws IllegalStateException if this method is invoked outside the execution of the rule.
+   */
   public Elements getElements() {
     checkState(elements != null, "Not running within the rule");
     return elements;
   }
 
+  /**
+   * Returns the {@link Types} instance associated with the current execution of the rule.
+   *
+   * @throws IllegalStateException if this method is invoked outside the execution of the rule.
+   */
   public Types getTypes() {
     checkState(elements != null, "Not running within the rule");
     return types;
