Made sure javadoc on Java 8 passes without linter errors on API modules

api/pom.xml

@@ -1,11 +1,25 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<groupId>org.eobjects.datacleaner</groupId>
 		<artifactId>DataCleaner</artifactId>
 		<version>4.1-SNAPSHOT</version>
 	</parent>
 	<artifactId>DataCleaner-api</artifactId>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<configuration>
+					<skip>false</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.apache.metamodel</groupId>

api/src/main/java/org/datacleaner/api/Initialize.java

@@ -54,7 +54,8 @@
  * consulted to determine if the initialization methods should be executed on
  * all nodes or just on a single (typically master) node, before distribution.
  * 
- * @Initialize is often used in conjunction with the @Close annotation.
+ * {@link Initialize} is often used in conjunction with the {@link Close}
+ * annotation.
  * 
  * @see Close
  */

api/src/main/java/org/datacleaner/api/InputRow.java

@@ -28,10 +28,6 @@
  * An InputRow can contain both values that are physical (ie. a raw output from
  * a datastore) and virtual (ie. generated values, created by Transformers).
  * 
- * The contents of an InputRow is visualized in the image below:
- * 
- * <img src="doc-files/AnalyzerBeans-inputrow.png" alt="InputRow contents" />
- * 
  * @see Transformer
  * @see InputColumn
  */

api/src/main/java/org/datacleaner/api/OutputColumns.java

@@ -25,11 +25,6 @@
 /**
  * Represents the output columns yielded by a Transformer given a certain
  * configuration.
- * 
- * By default the output columns of a transformer will have the type specified
- * by the generic argument (E) in {@link Transformer}<E>. The column type can
- * however be overridden using the output columns, by setting specific column
- * types per column index using the {@link #setColumnType(int, Class)} method.
  */
 public class OutputColumns implements Serializable {
 

api/src/main/java/org/datacleaner/descriptors/ComponentDescriptor.java

@@ -90,7 +90,7 @@ public interface ComponentDescriptor<B> extends Comparable<ComponentDescriptor<?
     /**
      * Gets the configured properties that have {@link InputColumn} type.
      * 
-     * @param onlyRequired
+     * @param includeOptional
      *            a boolean indicating if optional properties should be
      *            returned. If false, only required properties will be included.
      * @return a set containing all configured property descriptors of

api/src/main/java/org/datacleaner/descriptors/DescriptorProvider.java

@@ -39,7 +39,7 @@
  * {@link AnalysisJob}s coming from e.g. XML files or other serialized formats.
  * 
  * Many of the descriptors provided by this class can also be generated by the
- * {@link Descriptors} helper methods. It is however advised to use the
+ * <b>Descriptors</b> class' helper methods. It is however advised to use the
  * {@link DescriptorProvider} since it keeps a proper registry of descriptors
  * used, and reuses existing descriptor definitions.
  */

api/src/main/java/org/datacleaner/descriptors/FilterDescriptor.java

@@ -29,8 +29,10 @@
 /**
  * {@link ComponentDescriptor} interface for {@link Filter}s.
  * 
- * @param <B>
+ * @param <F>
  *            the type of {@link Filter}
+ * @param <C>
+ *            the {@link Filter}s category type
  */
 public interface FilterDescriptor<F extends Filter<C>, C extends Enum<C>> extends ComponentDescriptor<F> {
 

api/src/main/java/org/datacleaner/descriptors/RendererBeanDescriptor.java

@@ -25,20 +25,39 @@
 import org.datacleaner.api.RenderingFormat;
 
 /**
- * Defines an abstract descriptor for renderer beans.
+ * Defines an abstract {@link ComponentDescriptor} for {@link Renderer}s.
  * 
  * @see RendererBean
- * 
- * 
- * 
- * @param <B>
- *            the Bean type
+ *
+ * @param <R>
+ *            the type of {@link Renderer}
  */
 public interface RendererBeanDescriptor<R extends Renderer<?, ?>> extends ComponentDescriptor<R> {
 
+    /**
+     * Gets the {@link RenderingFormat} that this renderer pertains to. The type
+     * returned by {@link RenderingFormat#getOutputClass()} will typically
+     * correspond to accepted types of {@link #isOutputApplicableFor(Class)}.
+     * 
+     * @return
+     */
     public Class<? extends RenderingFormat<?>> getRenderingFormat();
 
+    /**
+     * Gets the type of {@link Renderable} that this renderer can render.
+     * 
+     * @return
+     */
     public Class<? extends Renderable> getRenderableType();
 
+    /**
+     * Determines if an object of the provided class argument can be provided
+     * using this renderer.
+     * 
+     * @see #getRenderingFormat()
+     * 
+     * @param requiredClass
+     * @return
+     */
     boolean isOutputApplicableFor(Class<?> requiredClass);
 }

api/src/main/java/org/datacleaner/job/AnalysisJob.java

@@ -33,11 +33,9 @@
  * A {@link AnalysisJob} references a source {@link Datastore} and some
  * {@link Column}s (represented via {@link InputColumn}s) of this datastore.
  * 
- * Building jobs is usually done using the
- * {@link org.datacleaner.job.builder.AnalysisJobBuilder} class.
+ * Building jobs is usually done using the <b>AnalysisJobBuilder</b> class.
  * 
- * Executing jobs is usually done using the
- * {@link org.datacleaner.job.runner.AnalysisRunner} interface.
+ * Executing jobs is usually done using the <b>AnalysisRunner</b> interface.
  */
 public interface AnalysisJob {
 

api/src/main/java/org/datacleaner/job/ComponentRequirement.java

@@ -48,7 +48,7 @@ public interface ComponentRequirement extends Serializable {
      * Gets the {@link FilterOutcome}s that this requirement depends on at
      * processing time. During processing, each {@link FilterOutcome} returned
      * from this method will have been evaluated before calling
-     * {@link #isSatisfied(FilterOutcomes)}.
+     * {@link #isSatisfied(InputRow, FilterOutcomes)}.
      * 
      * @return
      */
@@ -62,4 +62,13 @@ public interface ComponentRequirement extends Serializable {
      * @return
      */
     public String getSimpleName();
+
+    /**
+     * Provides textual representation of context and technical information
+     * about the {@link ComponentRequirement}
+     * 
+     * @return
+     */
+    @Override
+    public String toString();
 }

api/src/main/java/org/datacleaner/metadata/HasColumnMetadata.java

@@ -43,7 +43,7 @@ public interface HasColumnMetadata {
     /**
      * Gets {@link ColumnMetadata} for a particular {@link Column}.
      * 
-     * @param columnName
+     * @param column
      * @return a {@link ColumnMetadata} object, or null if no metadata about the
      *         column is available.
      */

api/src/main/java/org/datacleaner/reference/StringPattern.java

@@ -30,7 +30,7 @@
  * <li>The pattern "Aaaaaa Aaaaaaaaaa" which is a typical firstname and lastname
  * pattern.</li>
  * <li>The pattern ".*@.*" which is a simple way to identify strings with an
- * @-sign in them (potential email).</li>
+ * '@'-sign in them (potential email).</li>
  * </ul>
  * 
  * A string pattern can have methods annotated with @Initialize and @Close.

api/src/main/java/org/datacleaner/storage/RowAnnotationFactory.java

@@ -21,8 +21,10 @@
 
 import java.util.Map;
 
+import org.datacleaner.api.Component;
 import org.datacleaner.api.InputColumn;
 import org.datacleaner.api.InputRow;
+import org.datacleaner.api.Provided;
 
 /**
  * The RowAnnotationFactory represents a mechanism used to annotate/label rows
@@ -31,10 +33,8 @@
  * component needs to manage a set of labels but where storing them in
  * collections would be too complicated and would fill up memory.
  * 
- * The RowAnnotationFactory is injectable into any row processing component
- * (analyzer, transformer, filter) using the @Provided annotation.
- * 
- * @see Provided
+ * The RowAnnotationFactory is injectable into any {@link Component} (analyzer,
+ * transformer, filter) using the {@link Provided} annotation.
  */
 public interface RowAnnotationFactory {
 
@@ -44,7 +44,7 @@ public interface RowAnnotationFactory {
      * @return a new annotation
      */
     public RowAnnotation createAnnotation();
-    
+
     /**
      * Annotates an array of rows (all assumed to have distinct count = 1).
      * 

desktop/api/pom.xml

@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<groupId>org.eobjects.datacleaner</groupId>
@@ -8,6 +9,18 @@
 	<artifactId>DataCleaner-desktop-api</artifactId>
 	<packaging>jar</packaging>
 
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<configuration>
+					<skip>false</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
 	<dependencies>
 		<!-- DataCleaner core / environment -->
 		<dependency>

desktop/api/src/main/java/org/datacleaner/util/WidgetUtils.java

@@ -363,7 +363,7 @@ public static void addToGridBag(Component comp, JPanel panel, int x, int y, int
      * 
      * @param comp
      * @param panel
-     * @param gridxs
+     * @param gridx
      * @param gridy
      */
     public static void addToGridBag(Component comp, JPanel panel, int gridx, int gridy) {

desktop/api/src/main/java/org/datacleaner/widgets/DefaultToggleButtonUI.java

@@ -23,12 +23,15 @@
 import java.awt.Cursor;
 
 import javax.swing.AbstractButton;
+import javax.swing.JToggleButton;
+import javax.swing.plaf.ButtonUI;
 import javax.swing.plaf.metal.MetalToggleButtonUI;
 
 import org.datacleaner.util.WidgetUtils;
 
 /***
- * A {@link ToggleButtonUI} for default buttons in the DataCleaner user interface.
+ * A {@link ButtonUI} for default {@link JToggleButton}s in the DataCleaner user
+ * interface.
  */
 public class DefaultToggleButtonUI extends MetalToggleButtonUI {
 

desktop/api/src/main/java/org/datacleaner/widgets/table/DCTable.java

@@ -261,7 +261,7 @@ private boolean forwardMouseEvent(MouseEvent e) {
      * Copies content from the table to the clipboard. Algorithm is a slight
      * rewrite of the article below.
      * 
-     * @see http://www.copy--paste.org/copy-paste-jtables-excel.htm
+     * @see <a href="http://www.copy--paste.org/copy-paste-jtables-excel.htm">http://www.copy--paste.org/copy-paste-jtables-excel.htm</a>
      */
     public void copyToClipboard(int rowIndex, int colIndex, int width, int height) {
         StringBuilder sb = new StringBuilder();