Fix Javadoc warnings

src/com/xilinx/rapidwright/design/DesignTools.java

@@ -3373,7 +3373,7 @@ public static void createModuleInstsFromModuleImplsInsts(Design design, Collecti
      * Determine if a Net is driven by a hierarchical port, created as part of an out-of-context
      * synthesis flow, for example.
      * @param net Net to examine.
-     * @returns True if driven by a hierport.
+     * @return True if driven by a hierport.
      */
     public static boolean isNetDrivenByHierPort(Net net) {
         if (net.getSource() != null) {

src/com/xilinx/rapidwright/design/ModuleInst.java

@@ -524,9 +524,9 @@ public Net getCorrespondingNet(Port p) {
 
 
     /**
-     * Get's the corresponding port on the module by name.
+     * Gets the corresponding port on the module by name.
      * @param name
-     * @return
+     * @return Port object.
      */
     public Port getPort(String name) {
         return module.getPort(name);

src/com/xilinx/rapidwright/design/merge/MergeDesigns.java

@@ -33,7 +33,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-
 import com.xilinx.rapidwright.design.Design;
 import com.xilinx.rapidwright.design.DesignTools;
 import com.xilinx.rapidwright.design.Net;
@@ -46,8 +45,9 @@
 import com.xilinx.rapidwright.tests.CodePerfTracker;
 
 /**
- * Merges two or more designs into a single Design.  Merge process can be customized through the
- * use of the {@link MergeOptions} class.
+ * Merges two or more designs into a single Design. Merge process can be
+ * customized through the use of the @link {@link AbstractDesignMerger}
+ * interface.
  */
 public class MergeDesigns {
 
@@ -127,8 +127,7 @@ public static Design mergeDesigns(Design...designs) {
      * netlist.  Assumes that designs are compatible for merging. Assumes that if there are duplicate
      * cells in the set of designs to be merged that they are flip-flops and that they are always
      * connected to a top-level port.
-     * @param options The set of options to customize the merge process based on netlist-specific
-     * names
+     * @param merger The specific design merger instance to use to merge the designs
      * @param designs The set of designs to be merged into a single design.
      * @return The merged design that contains the superset of all logic, placement and routing of
      * the input designs.

src/com/xilinx/rapidwright/edif/BinaryEDIFReader.java

@@ -66,7 +66,7 @@ private static boolean readEDIFName(EDIFName o, Input is, String[] strings) {
      * @param o The object to read
      * @param is The Kryo-based input stream
      * @param strings Indexed string lookup
-     * @see BinaryEDIFWriter#writeEDIFObject(EDIFPropertyObject, Output, Map<String,Integer>)
+     * @see BinaryEDIFWriter#writeEDIFObject(EDIFPropertyObject, Output, Map)
      */
     static void readEDIFObject(EDIFPropertyObject o, Input is, String[] strings) {
         if (readEDIFName(o, is, strings)) {

src/com/xilinx/rapidwright/edif/BinaryEDIFWriter.java

@@ -156,7 +156,7 @@ private static void writeEDIFName(EDIFName o, Output os, Map<String,Integer> str
      * @param o The object write
      * @param os The Kryo-based output stream
      * @param stringMap Map of String to enumeration integers
-     * @see #readEDIFObject(EDIFPropertyObject, Output, Map)
+     * @see BinaryEDIFReader#readEDIFObject(EDIFPropertyObject, Input, String[])
      */
     private static void writeEDIFObject(EDIFPropertyObject o, Output os, Map<String,Integer> stringMap) {
         boolean hasProperties = o.getPropertiesMap().size() > 0;

src/com/xilinx/rapidwright/edif/EDIFCell.java

@@ -249,8 +249,8 @@ public EDIFPort addPort(EDIFPort port) {
 
     /**
      * Gets a port by bus name (see {@link EDIFPort#getBusName()}). Multi-bit ports
-     * need to have closing square bracket and range removed (for example: "bus[3:0]"
-     * -> "bus[". See {@link EDIFCell#addPort(EDIFPort)} for more information.
+     * need to have closing square bracket and range removed (for example:
+     * {@code "bus[3:0]" -> "bus["}). See {@link EDIFCell#addPort(EDIFPort)} for more information.
      *
      * @param name Bus name (ends with '[' to represent a bussed port) of the
      *                port to get. Single bit ports use their entire name.

src/com/xilinx/rapidwright/edif/EDIFPortCache.java

@@ -28,7 +28,7 @@
 import java.util.Map;
 
 /**
- * Cache for speeding up {@link EDIFCell#getPortByLegalName(String)} when querying many ports
+ * Cache for speeding up {@link EDIFCell#getPortByLegalName(String, EDIFReadLegalNameCache)} when querying many ports
  */
 public class EDIFPortCache {
     private final Map<String, EDIFPort> cache;

src/com/xilinx/rapidwright/interchange/LogNetlistReader.java

@@ -138,7 +138,7 @@ protected EDIFCellInst getInst(int i) {
     /**
      * Extracts the property map information from a Cap'n Proto reader object and deserializes it
      * into an EDIF property map object. The reverse function is
-     * {@link LogNetlistWriter#populatePropertyMap(Supplier<PropertyMap.Builder>, EDIFPropertyObject)}
+     * {@link LogNetlistWriter#populatePropertyMap(Supplier, EDIFPropertyObject)}
      * @param reader The Cap'n Proto reader object
      * @param obj The EDIF map object
      */

src/com/xilinx/rapidwright/interchange/PhysNetlistWriter.java

@@ -84,9 +84,9 @@ public class PhysNetlistWriter {
     /**
      * The Interchange format allows for all physical routing resources to be
      * specified, e.g.
-     *   ... -> PIP -> SitePin -> BELPin(output) -> BELPin(input) -> SitePIP -> BELPin(output) -> BELPin(input)
+     *   {@code ... -> PIP -> SitePin -> BELPin(output) -> BELPin(input) -> SitePIP -> BELPin(output) -> BELPin(input)}
      * It may not be necessary to use specify all such resources, as many are implied:
-     *   ... -> PIP -> SitePin -> (implied)      -> (implied)     -> SitePIP -> (implied)      -> (implied)
+     *   {@code ... -> PIP -> SitePin -> (implied)      -> (implied)     -> SitePIP -> (implied)      -> (implied)}
      * Disabling this flag allows such implied resources to be omitted.
      */
     public static boolean VERBOSE_PHYSICAL_NET_ROUTING = true;

src/com/xilinx/rapidwright/util/FileTools.java

@@ -246,7 +246,7 @@ public static Output getKryoGzipOutputStream(String fileName) {
      * Creates a Kryo output stream that instantiates a gzip compression stream to
      * an output stream.
      * 
-     * @param fileName Name of the file to target.
+     * @param os The output stream to wrap.
      * @return The created kryo-gzip output file stream.
      */
     public static Output getKryoGzipOutputStream(OutputStream os) {
@@ -366,7 +366,7 @@ public static Input getKryoInputStream(InputStream in) {
      * Wraps the provided input stream with a kryo stream. Will call
      * {@link #useUnsafeStreams()} to decide on using unsafe or not.
      * 
-     * @param os The input stream to wrap.
+     * @param in The input stream to wrap.
      * @return The created kryo stream.
      */
     public static Input getKryoInputStreamWithoutInflater(InputStream in) {

src/com/xilinx/rapidwright/util/StringTools.java

@@ -268,7 +268,6 @@ public static String makeWhiteSpace(int length) {
      * 
      * @param items      The list of Strings to print
      * @param ps         The stream to send the printed Strings to.
-     * @param maxColumns A maximum limit to the number columns to print
      */
     public static void printListInColumns(List<String> items, PrintStream ps) {
         printListInColumns(items, ps, Integer.MAX_VALUE);