Merge pull request #29 from zcervink/28

Fix the errors in the javadoc

Fixes #24

Signed-off-by: Zbynek Cervinka <[email protected]>

Author: zcervink

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/UITestRunner.java

@@ -47,6 +47,7 @@ public class UITestRunner {
      *
      * @param ideaVersion version of the IntelliJ Idea to start
      * @param port        port number on which will the IntelliJ Idea be listening
+     * @return instance of the RemoteRobot
      */
     public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
         UITestRunner.ideaVersion = ideaVersion;
@@ -73,6 +74,7 @@ public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
      * Start the given version of IntelliJ Idea listening on the default port
      *
      * @param ideaVersion version of the IntelliJ Idea to start
+     * @return instance of the RemoteRobot
      */
     public static RemoteRobot runIde(IdeaVersion ideaVersion) {
         return runIde(ideaVersion, defaultPort);
@@ -113,6 +115,7 @@ public static RemoteRobot getRemoteRobot() {
      *
      * @param port port number
      * @return instance of the RemoteRobot
+     * @throws InterruptedException may be thrown in Thread.sleep()
      */
     public static RemoteRobot getRemoteRobotConnection(int port) throws InterruptedException {
         RemoteRobot remoteRobot = new RemoteRobot("http://127.0.0.1:" + port);

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/mainIdeWindow/toolWindowsPane/ToolWindowsPane.java

@@ -55,6 +55,7 @@ public ToolWindowsPane(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponen
     /**
      * Create fixture for the Stripe button
      *
+     * @param label label text of the stripe button
      * @return fixture for the Stripe button
      */
     public ComponentFixture stripeButton(String label) {
@@ -113,7 +114,8 @@ public void buildProject(ToolToBuildProject toolToBuildProject) {
     /**
      * Test is a file with given name on given path is available in the project tree
      *
-     * @param path        path to navigate
+     * @param path path to navigate to
+     * @return true if the given file exists on the given path in the project
      */
     public boolean isAProjectFilePresent(String... path) {
         try {

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/utils/testExtension/ScreenshotAfterTestFailExtension.java

@@ -25,10 +25,10 @@
 
 /**
  * ScreenshotAfterTestFailExtension takes screenshot immediately after test has failed
- * and perform a clean up to ensure no dialog or windows is opened
+ * and perform a clean up to ensure no dialog or windows is opened<br>
  *
- * USAGE: Add the following annotation before every class with JUnit tests
- *        @ExtendWith(ScreenshotAfterTestFailExtension.class)
+ * <b>USAGE:</b> Add the following annotation before every class with JUnit tests:
+ * {@code @ExtendWith(ScreenshotAfterTestFailExtension.class)}<br>
  *
  * @author [email protected]
  *