warnings and javadoc

Author: Andres Pegam

example-project/src/main/java/io/wcm/qa/galenium/example/pageobjects/ConferencePage.java

@@ -24,6 +24,9 @@
  */
 public class ConferencePage extends AbstractPage {
 
+  /**
+   * Relative path to conference page.
+   */
   public static final String PATH_TO_CONFERENCE = "/en/conference.html";
 
   @Override

example-project/src/main/java/io/wcm/qa/galenium/example/pageobjects/Homepage.java

@@ -24,6 +24,9 @@
  */
 public class Homepage extends AbstractPage {
 
+  /**
+   * Relative path to home page.
+   */
   public static final String PATH_TO_HOMEPAGE = "/en.html";
 
   @Override

galenium/src/main/java/io/wcm/qa/galenium/exceptions/GaleniumException.java

@@ -26,12 +26,19 @@ public class GaleniumException extends RuntimeException {
 
   private static final long serialVersionUID = 7561233675534113771L;
 
+  /**
+   * @param msg message for exception
+   */
   public GaleniumException(String msg) {
     super(msg);
   }
 
-  public GaleniumException(String message, Throwable ex) {
-    super(message, ex);
+  /**
+   * @param msg message for exception
+   * @param ex optional exception
+   */
+  public GaleniumException(String msg, Throwable ex) {
+    super(msg, ex);
   }
 
 }

galenium/src/main/java/io/wcm/qa/galenium/listeners/DefaultGaleniumListener.java

@@ -39,15 +39,23 @@ public class DefaultGaleniumListener extends TestListenerAdapter {
 
   private List<ITestListener> listeners = new ArrayList<ITestListener>();
 
+  /**
+   * Constructor.
+   */
   public DefaultGaleniumListener() {
     add(new LoggingListener());
     add(new ExtentReportsListener());
     add(new WebDriverListener());
     add(new TextSamplePersistenceListener());
   }
 
-  public boolean add(ITestListener e) {
-    return listeners.add(e);
+  /**
+   * Adds an additional test listener.
+   * @param listener to add
+   * @return true
+   */
+  public boolean add(ITestListener listener) {
+    return listeners.add(listener);
   }
 
   @Override

galenium/src/main/java/io/wcm/qa/galenium/listeners/ExtentReportsListener.java

@@ -39,7 +39,9 @@
 import io.wcm.qa.galenium.util.TestDevice;
 import io.wcm.qa.galenium.webdriver.WebDriverManager;
 
-
+/**
+ * Handles {@link ExtentReports} life cycle.
+ */
 public class ExtentReportsListener implements ITestListener, IConfigurationListener2 {
 
   @Override

galenium/src/main/java/io/wcm/qa/galenium/listeners/WebDriverListener.java

@@ -25,6 +25,7 @@
 import static io.wcm.qa.galenium.util.GaleniumConfiguration.isSuppressAutoAdjustBrowserSize;
 import static io.wcm.qa.galenium.util.GaleniumContext.getDriver;
 
+import org.openqa.selenium.WebDriver;
 import org.slf4j.Logger;
 import org.slf4j.Marker;
 import org.slf4j.MarkerFactory;
@@ -42,7 +43,9 @@
 import io.wcm.qa.galenium.util.TestInfoUtil;
 import io.wcm.qa.galenium.webdriver.WebDriverManager;
 
-
+/**
+ * Handles {@link WebDriver} life cycle in single and multi threaded scenarios.
+ */
 public class WebDriverListener implements ITestListener {
 
   private static final Marker MARKER_WEBDRIVER = MarkerFactory.getMarker("webdriver");

galenium/src/main/java/io/wcm/qa/galenium/providers/TestNgProviderUtil.java

@@ -28,7 +28,7 @@
 /**
  * Utility class to help with writing {@link DataProvider} code.
  */
-final public class TestNgProviderUtil {
+public final class TestNgProviderUtil {
 
   private TestNgProviderUtil() {
     // do not instantiate

galenium/src/main/java/io/wcm/qa/galenium/reporting/GaleniumReportUtil.java

@@ -122,12 +122,20 @@ public static void addGalenResult(GalenTestInfo galenTestInfo) {
     }
   }
 
+  /**
+   * Assigns categories to {@link ExtentTest}.
+   * @param categories to add
+   */
   public static void assignCategories(String... categories) {
     for (String category : categories) {
       assignCategory(category);
     }
   }
 
+  /**
+   * Assigns a single category to {@link ExtentTest}.
+   * @param category to add
+   */
   public static void assignCategory(String category) {
     ExtentTest extentTest = getExtentTest();
     List<TestAttribute> categoryList = extentTest.getTest().getCategoryList();
@@ -220,10 +228,18 @@ public static ExtentTest getExtentTest(String name) {
     return currentReport;
   }
 
+  /**
+   * Gets a logger which marks every entry with the passed {@link Marker}.
+   * @param marker to use with this logger
+   * @return a {@link MarkedLogger} using the marker
+   */
   public static Logger getMarkedLogger(Marker marker) {
     return new MarkedLogger(getLogger(), marker);
   }
 
+  /**
+   * @return the logger used for the current test, if no test is set, it will use "NO_TEST_NAME_SET" as the test name
+   */
   public static Logger getLogger() {
     String name = "NO_TEST_NAME_SET";
     ExtentTest extentTest = getExtentTest();

galenium/src/main/java/io/wcm/qa/galenium/reporting/MarkedLogger.java

@@ -23,11 +23,18 @@
 import org.slf4j.Marker;
 import org.slf4j.MarkerFactory;
 
+/**
+ * Wraps a {@link Logger} in a way that marks every statement with the configured additional marker.
+ */
 public class MarkedLogger implements Logger {
 
   private Logger delegate;
   private Marker markerToAdd;
 
+  /**
+   * @param delegateLogger logger to wrap
+   * @param additionalMarker marker to use
+   */
   public MarkedLogger(Logger delegateLogger, Marker additionalMarker) {
     delegate = delegateLogger;
     markerToAdd = additionalMarker;

galenium/src/main/java/io/wcm/qa/galenium/sampling/differences/DifferenceNameComparator.java

@@ -21,7 +21,9 @@
 
 import java.util.Comparator;
 
-
+/**
+ * Sort differences by their name.
+ */
 public class DifferenceNameComparator implements Comparator<Difference> {
 
   @Override