doc: Fix javadocs errors and improve travis script for checking it (#…

…1731)

chore/travis/travis-verify.sh

@@ -7,4 +7,4 @@
 source /opt/jdk_switcher/jdk_switcher.sh
 pip install --user CommonMark requests pygithub
 
-jdk_switcher use oraclejdk9 && mvn -Djava.src.version=1.9 verify site install -DskipTests && python ./chore/check-links-in-doc.py
+jdk_switcher use oraclejdk9 && mvn -Djava.src.version=1.9 verify site javadoc:jar install -DskipTests && python ./chore/check-links-in-doc.py

pom.xml

@@ -508,6 +508,11 @@
             </lifecycleMappingMetadata>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <version>3.0.0-M1</version>
+        </plugin>
       </plugins>
     </pluginManagement>
     <extensions>

src/main/java/spoon/reflect/declaration/CtElement.java

@@ -317,7 +317,7 @@ <E extends CtElement> List<E> getAnnotatedChildren(
 
 	/**
 	 * @return a a single value (eg a CtElement), List, Set or Map depending on this `element` and `role`. Returned collections are read-only.
-	 * @param the role of the returned attribute with respect to this element.
+	 * @param role the role of the returned attribute with respect to this element.
 	 *
 	 * For instance, "klass.getValueByRole(CtRole.METHOD)" returns a list of methods.
 	 *
@@ -327,7 +327,7 @@ <E extends CtElement> List<E> getAnnotatedChildren(
 
 	/**
 	 * Sets a field according to a role.
-	 * @param the role of the field to be set
+	 * @param role the role of the field to be set
 	 * @param value to be assigned to this field.
 	 */
 	<E extends CtElement, T> E  setValueByRole(CtRole role, T value);

src/main/java/spoon/reflect/factory/Factory.java

@@ -912,7 +912,7 @@ public interface Factory {
 	CtPackage createPackage(CtPackage parent, String simpleName);
 
 	/**
-	 * @see CoreFactory#create(Class<? extends CtElement>)
+	 * @see CoreFactory#create(Class)
 	 */
 	CtElement createElement(Class<? extends CtElement> klass);
 }

src/main/java/spoon/reflect/visitor/CtBiScannerDefault.java

@@ -23,7 +23,7 @@
  * Ensures that all children nodes are visited once, a visit means three method
  * calls, one call to "enter", one call to "exit" and one call to biScan.
  *
- * This class is generated automatically by the processor {@link spoon.generating.CtBiScannerGenerator}.
+ * This class is generated automatically by the processor spoon.generating.CtBiScannerGenerator.
  *
  * Is used by EqualsVisitor.
  */

src/main/java/spoon/support/reflect/package.html

@@ -24,7 +24,7 @@
 
     <p>This package provides an implementation of the spoon.reflect package.</p>
 
-    <p>The classes of this package should not be instantiated directly, but by using {@link spoon.reflect.CtFactory}.
+    <p>The classes of this package should not be instantiated directly, but by using {@link spoon.reflect.factory.Factory}.
 
 <h2>Related Documentation</h2>
 

src/main/java/spoon/support/visitor/clone/CloneBuilder.java

@@ -21,7 +21,7 @@
 /**
  * Used to set all data in the cloned element.
  *
- * This class is generated automatically by the processor {@link spoon.generating.CloneVisitorGenerator}.
+ * This class is generated automatically by the processor spoon.generating.CloneVisitorGenerator.
  */
 public class CloneBuilder extends spoon.reflect.visitor.CtInheritanceScanner {
 	public static <T extends spoon.reflect.declaration.CtElement> T build(spoon.reflect.declaration.CtElement element, spoon.reflect.declaration.CtElement other) {

src/main/java/spoon/support/visitor/clone/CloneVisitor.java

@@ -20,7 +20,7 @@
 /**
  * Used to clone a given element.
  *
- * This class is generated automatically by the processor {@link spoon.generating.CloneVisitorGenerator}.
+ * This class is generated automatically by the processor spoon.generating.CloneVisitorGenerator.
  */
 public class CloneVisitor extends spoon.reflect.visitor.CtScanner {
 	private final spoon.support.visitor.equals.CloneHelper cloneHelper;

src/main/java/spoon/support/visitor/replace/ReplacementVisitor.java

@@ -20,7 +20,7 @@
 /**
  * Used to replace an element by another one.
  *
- * This class is generated automatically by the processor {@link spoon.generating.ReplacementVisitorGenerator}.
+ * This class is generated automatically by the processor spoon.generating.ReplacementVisitorGenerator.
  */
 public class ReplacementVisitor extends spoon.reflect.visitor.CtScanner {
 	private spoon.reflect.declaration.CtElement original;

src/test/java/spoon/generating/clone/CloneVisitorTemplate.java

@@ -24,7 +24,7 @@
 /**
  * Used to clone a given element.
  *
- * This class is generated automatically by the processor {@link spoon.generating.CloneVisitorGenerator}.
+ * This class is generated automatically by the processor spoon.generating.CloneVisitorGenerator.
  */
 class CloneVisitorTemplate extends CtScanner {
 	private final CloneHelper cloneHelper;

src/test/java/spoon/generating/replace/ReplacementVisitor.java

@@ -36,7 +36,7 @@
 /**
  * Used to replace an element by another one.
  *
- * This class is generated automatically by the processor {@link spoon.generating.ReplacementVisitorGenerator}.
+ * This class is generated automatically by the processor spoon.generating.ReplacementVisitorGenerator.
  */
 class ReplacementVisitor extends CtScanner {
 	public static void replace(CtElement original, CtElement replace) {

src/test/java/spoon/generating/scanner/CtBiScannerTemplate.java

@@ -24,7 +24,7 @@
  * Ensures that all children nodes are visited once, a visit means three method
  * calls, one call to "enter", one call to "exit" and one call to biScan.
  *
- * This class is generated automatically by the processor {@link spoon.generating.CtBiScannerGenerator}.
+ * This class is generated automatically by the processor spoon.generating.CtBiScannerGenerator.
  *
  * Is used by EqualsVisitor.
  */