Cleaning up javadoc warnings.

pom.xml

@@ -158,6 +158,7 @@
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>3.6.3</version>
 				<configuration>
+					<doclint>none</doclint>
 					<source>${minimum.java.version}</source>
 					<destDir>docs</destDir>
 					<excludePackageNames>com.marginallyclever.robotoverlord.*</excludePackageNames>

src/main/java/com/marginallyclever/communications/application/ConversationEvent.java

@@ -1,7 +1,9 @@
 package com.marginallyclever.communications.application;
 
 /**
- *
+ * {@link ConversationEvent} is a simple record to hold a conversation event.
+ * @param whoSpoke the name of the person who spoke
+ * @param whatWasSaid what was said
  */
 public record ConversationEvent(String whoSpoke, String whatWasSaid) {
 	@Override

src/main/java/com/marginallyclever/convenience/AnsiColors.java

@@ -7,75 +7,246 @@
  */
 public class AnsiColors {
     // Reset
-    public static final String RESET = "\033[0m";  // Text Reset
+    /**
+     *  Text Reset
+     */
+    public static final String RESET = "\033[0m";
 
     // Regular Colors
-    public static final String BLACK = "\033[0;30m";   // BLACK
-    public static final String RED = "\033[0;31m";     // RED
-    public static final String GREEN = "\033[0;32m";   // GREEN
-    public static final String YELLOW = "\033[0;33m";  // YELLOW
-    public static final String BLUE = "\033[0;34m";    // BLUE
-    public static final String PURPLE = "\033[0;35m";  // PURPLE
-    public static final String CYAN = "\033[0;36m";    // CYAN
-    public static final String WHITE = "\033[0;37m";   // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK = "\033[0;30m";
+    /**
+     *  RED
+     */
+    public static final String RED = "\033[0;31m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN = "\033[0;32m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW = "\033[0;33m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE = "\033[0;34m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE = "\033[0;35m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN = "\033[0;36m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE = "\033[0;37m";
 
     // Bold
-    public static final String BLACK_BOLD = "\033[1;30m";  // BLACK
-    public static final String RED_BOLD = "\033[1;31m";    // RED
-    public static final String GREEN_BOLD = "\033[1;32m";  // GREEN
-    public static final String YELLOW_BOLD = "\033[1;33m"; // YELLOW
-    public static final String BLUE_BOLD = "\033[1;34m";   // BLUE
-    public static final String PURPLE_BOLD = "\033[1;35m"; // PURPLE
-    public static final String CYAN_BOLD = "\033[1;36m";   // CYAN
-    public static final String WHITE_BOLD = "\033[1;37m";  // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_BOLD = "\033[1;30m";
+    /**
+     *  RED
+     */
+    public static final String RED_BOLD = "\033[1;31m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_BOLD = "\033[1;32m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_BOLD = "\033[1;33m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_BOLD = "\033[1;34m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_BOLD = "\033[1;35m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_BOLD = "\033[1;36m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_BOLD = "\033[1;37m";
 
     // Underline
-    public static final String BLACK_UNDERLINED = "\033[4;30m";  // BLACK
-    public static final String RED_UNDERLINED = "\033[4;31m";    // RED
-    public static final String GREEN_UNDERLINED = "\033[4;32m";  // GREEN
-    public static final String YELLOW_UNDERLINED = "\033[4;33m"; // YELLOW
-    public static final String BLUE_UNDERLINED = "\033[4;34m";   // BLUE
-    public static final String PURPLE_UNDERLINED = "\033[4;35m"; // PURPLE
-    public static final String CYAN_UNDERLINED = "\033[4;36m";   // CYAN
-    public static final String WHITE_UNDERLINED = "\033[4;37m";  // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_UNDERLINED = "\033[4;30m";
+    /**
+     *  RED
+     */
+    public static final String RED_UNDERLINED = "\033[4;31m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_UNDERLINED = "\033[4;32m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_UNDERLINED = "\033[4;33m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_UNDERLINED = "\033[4;34m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_UNDERLINED = "\033[4;35m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_UNDERLINED = "\033[4;36m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_UNDERLINED = "\033[4;37m";
 
     // Background
-    public static final String BLACK_BACKGROUND = "\033[40m";  // BLACK
-    public static final String RED_BACKGROUND = "\033[41m";    // RED
-    public static final String GREEN_BACKGROUND = "\033[42m";  // GREEN
-    public static final String YELLOW_BACKGROUND = "\033[43m"; // YELLOW
-    public static final String BLUE_BACKGROUND = "\033[44m";   // BLUE
-    public static final String PURPLE_BACKGROUND = "\033[45m"; // PURPLE
-    public static final String CYAN_BACKGROUND = "\033[46m";   // CYAN
-    public static final String WHITE_BACKGROUND = "\033[47m";  // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_BACKGROUND = "\033[40m";
+    /**
+     *  RED
+     */
+    public static final String RED_BACKGROUND = "\033[41m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_BACKGROUND = "\033[42m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_BACKGROUND = "\033[43m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_BACKGROUND = "\033[44m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_BACKGROUND = "\033[45m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_BACKGROUND = "\033[46m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_BACKGROUND = "\033[47m";
 
     // High Intensity
-    public static final String BLACK_BRIGHT = "\033[0;90m";  // BLACK
-    public static final String RED_BRIGHT = "\033[0;91m";    // RED
-    public static final String GREEN_BRIGHT = "\033[0;92m";  // GREEN
-    public static final String YELLOW_BRIGHT = "\033[0;93m"; // YELLOW
-    public static final String BLUE_BRIGHT = "\033[0;94m";   // BLUE
-    public static final String PURPLE_BRIGHT = "\033[0;95m"; // PURPLE
-    public static final String CYAN_BRIGHT = "\033[0;96m";   // CYAN
-    public static final String WHITE_BRIGHT = "\033[0;97m";  // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_BRIGHT = "\033[0;90m";
+    /**
+     *  RED
+     */
+    public static final String RED_BRIGHT = "\033[0;91m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_BRIGHT = "\033[0;92m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_BRIGHT = "\033[0;93m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_BRIGHT = "\033[0;94m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_BRIGHT = "\033[0;95m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_BRIGHT = "\033[0;96m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_BRIGHT = "\033[0;97m";
 
     // Bold High Intensity
-    public static final String BLACK_BOLD_BRIGHT = "\033[1;90m"; // BLACK
-    public static final String RED_BOLD_BRIGHT = "\033[1;91m";   // RED
-    public static final String GREEN_BOLD_BRIGHT = "\033[1;92m"; // GREEN
-    public static final String YELLOW_BOLD_BRIGHT = "\033[1;93m";// YELLOW
-    public static final String BLUE_BOLD_BRIGHT = "\033[1;94m";  // BLUE
-    public static final String PURPLE_BOLD_BRIGHT = "\033[1;95m";// PURPLE
-    public static final String CYAN_BOLD_BRIGHT = "\033[1;96m";  // CYAN
-    public static final String WHITE_BOLD_BRIGHT = "\033[1;97m"; // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_BOLD_BRIGHT = "\033[1;90m";
+    /**
+     *  RED
+     */
+    public static final String RED_BOLD_BRIGHT = "\033[1;91m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_BOLD_BRIGHT = "\033[1;92m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_BOLD_BRIGHT = "\033[1;93m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_BOLD_BRIGHT = "\033[1;94m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_BOLD_BRIGHT = "\033[1;95m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_BOLD_BRIGHT = "\033[1;96m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_BOLD_BRIGHT = "\033[1;97m";
 
     // High Intensity backgrounds
-    public static final String BLACK_BACKGROUND_BRIGHT = "\033[0;100m";// BLACK
-    public static final String RED_BACKGROUND_BRIGHT = "\033[0;101m";// RED
-    public static final String GREEN_BACKGROUND_BRIGHT = "\033[0;102m";// GREEN
-    public static final String YELLOW_BACKGROUND_BRIGHT = "\033[0;103m";// YELLOW
-    public static final String BLUE_BACKGROUND_BRIGHT = "\033[0;104m";// BLUE
-    public static final String PURPLE_BACKGROUND_BRIGHT = "\033[0;105m"; // PURPLE
-    public static final String CYAN_BACKGROUND_BRIGHT = "\033[0;106m";  // CYAN
-    public static final String WHITE_BACKGROUND_BRIGHT = "\033[0;107m";   // WHITE
+    /**
+     *  BLACK
+     */
+    public static final String BLACK_BACKGROUND_BRIGHT = "\033[0;100m";
+    /**
+     *  RED
+     */
+    public static final String RED_BACKGROUND_BRIGHT = "\033[0;101m";
+    /**
+     *  GREEN
+     */
+    public static final String GREEN_BACKGROUND_BRIGHT = "\033[0;102m";
+    /**
+     *  YELLOW
+     */
+    public static final String YELLOW_BACKGROUND_BRIGHT = "\033[0;103m";
+    /**
+     *  BLUE
+     */
+    public static final String BLUE_BACKGROUND_BRIGHT = "\033[0;104m";
+    /**
+     *  PURPLE
+     */
+    public static final String PURPLE_BACKGROUND_BRIGHT = "\033[0;105m";
+    /**
+     *  CYAN
+     */
+    public static final String CYAN_BACKGROUND_BRIGHT = "\033[0;106m";
+    /**
+     *  WHITE
+     */
+    public static final String WHITE_BACKGROUND_BRIGHT = "\033[0;107m";
 }

src/main/java/com/marginallyclever/convenience/Ray.java

@@ -5,10 +5,9 @@
 import javax.vecmath.Vector3d;
 
 /**
- * 
+ * {@link Ray} is a starting point and a direction.
  * @author Dan Royer
  * @since 1.6.0
- *
  */
 public class Ray {
 	private final Point3d origin = new Point3d();

src/main/java/com/marginallyclever/ro3/apps/App.java

@@ -7,10 +7,18 @@
  * All apps extend from App for Reflection.
  */
 public class App extends JPanel {
+    /**
+     * Default constructor
+     */
     public App() {
         super();
     }
 
+    /**
+     * Constructor with layout manager
+     *
+     * @param layout the layout manager to use
+     */
     public App(LayoutManager layout) {
         super(layout);
     }

src/main/java/com/marginallyclever/ro3/apps/actions/AddNode.java

@@ -12,7 +12,10 @@
 import java.util.function.Supplier;
 
 /**
- * Add a new instance of a Node to every selected branches of the tree
+ * {@link AddNode} is an {@link AbstractAction} to add a new instance of a {@link Node} to every selected branch of the
+ * tree.  It will ask the user which type of {@link Node} to add, then create an
+ * {@link com.marginallyclever.ro3.apps.commands.AddNode} command to add the new {@link Node}.
+ * @param <T> the type of {@link Node} to add
  */
 public class AddNode<T extends Node> extends AbstractAction {
     private static final FactoryPanel<Node> nfd = new FactoryPanel<>(Registry.nodeFactory);

src/main/java/com/marginallyclever/ro3/apps/nodeselector/NodeSelector.java

@@ -22,6 +22,7 @@
  * type T.</p>
  * <p>{@link NodeSelector} also provides a <b>find</b> button.  The find action changes the global selection, which
  * updates any other systems listening to the selection.</p>
+ * @param <T> the type of {@link Node} to select
  */
 public class NodeSelector<T extends Node> extends JPanel {
     private T subject;

src/main/java/com/marginallyclever/ro3/mesh/Mesh.java

@@ -19,7 +19,7 @@
 
 /**
  * <p>{@link Mesh} contains the vertex data for a 3D model.  It may also contain normal, color, and texture data.</p>
- * <p></p>It uses <a href="https://www.khronos.org/opengl/wiki/Vertex_Specification">Vertex Array Objects and Vertex
+ * <p>It uses <a href="https://www.khronos.org/opengl/wiki/Vertex_Specification">Vertex Array Objects and Vertex
  * Buffer Objects</a> to optimize rendering large collections of triangles.</p>
  * @author Dan Royer
  */

src/main/java/com/marginallyclever/ro3/raypicking/RayHit.java

@@ -6,6 +6,9 @@
 
 /**
  * A ray hit is a record of a ray hitting a {@link MeshInstance} at a certain distance.
+ * @param target the MeshInstance that the {@link com.marginallyclever.convenience.Ray} intersected.
+ * @param distance the distance from the {@link com.marginallyclever.convenience.Ray} origin to the point of contact.
+ * @param normal the normal of the {@link com.marginallyclever.ro3.mesh.Mesh} at the point of contact, in world space.
  * @author Dan Royer
  * @since 2.5.0
  */