Add some javadoc around test integration
authorSir4ur0n <debon.julien@gmail.com>
Mon, 22 Oct 2018 09:47:23 +0000 (11:47 +0200)
committerAnna.Kozlova <anna.kozlova@jetbrains.com>
Mon, 22 Oct 2018 13:02:28 +0000 (15:02 +0200)
platform/lang-api/src/com/intellij/testIntegration/TestCreator.java
platform/lang-api/src/com/intellij/testIntegration/TestFinder.java

index bf90a3dfbaa328e38399c766c725cec3c5f95ddc..d3db134e77d4f7be20739ca944a56913624d7f82 100644 (file)
@@ -22,12 +22,20 @@ import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiFile;
 
 /**
- * Implementation of the extension are used on generating tests while navigation using GotoTestOrCodeAction
+ * Implementations of this extension are used on generating tests while navigation using GotoTestOrCodeAction. 
+ * Corresponding extension point qualified name is {@code com.intellij.testCreator}, see {@link com.intellij.testIntegration.LanguageTestCreators}
  * <p>
  * To decorate creating test action consider implementing {@link ItemPresentation}
  */
 public interface TestCreator {
+
+  /**
+   * Should "Create Test" action be available in this context?
+   */
   boolean isAvailable(Project project, Editor editor, PsiFile file);
 
+  /**
+   * Triggered when the user actually selects the "Create New Test..." action from the popup. Responsible for actually creating the test file.
+   */
   void createTest(Project project, Editor editor, PsiFile file);
 }
index 638267f38ac8ec94492e2f3a4c35030c90d470ca..8681a31d0d2fa330a2d8807b65d576e1cad16c67 100644 (file)
@@ -23,9 +23,19 @@ import org.jetbrains.annotations.Nullable;
 
 import java.util.Collection;
 
+/**
+ * Triggered when the user uses the "Navigation / Test"  action (= jump to test shortcut). 
+ * Corresponding extension point qualified name is {@code com.intellij.testFinder}.
+ */
 public interface TestFinder {
   ExtensionPointName<TestFinder> EP_NAME = ExtensionPointName.create("com.intellij.testFinder");
 
+  /**
+   * Retrieve the source element (PsiFile) to handle some UI elements, like the name displayed in "Choose Test for {file name}".
+   *
+   * @param from PsiElement where the cursor was when "Navigate to test" was triggered
+   * @return the parent PsiFile of the PsiElement where the cursor was when the test finder was invoked
+   */
   @Nullable
   PsiElement findSourceElement(@NotNull PsiElement from);
 
@@ -33,7 +43,7 @@ public interface TestFinder {
    * Finds tests for given class.
    *
    * @param element may by of any language but not specific to a current test finder domain language
-   * @return founded tests for class
+   * @return found tests for class
    */
   @NotNull
   Collection<PsiElement> findTestsForClass(@NotNull PsiElement element);
@@ -42,7 +52,7 @@ public interface TestFinder {
    * Finds classes for given test.
    *
    * @param element may by of any language but not specific to a current test finder domain language
-   * @return founded classes for test
+   * @return found classes for test
    */
   @NotNull
   Collection<PsiElement> findClassesForTest(@NotNull PsiElement element);