Fix javadoc for Java 8's strict javadoc tool

src/main/java/net/sourceforge/schemaspy/Config.java

@@ -141,7 +141,7 @@ public Config()
      * Construct a configuration from an array of options (e.g. from a command
      * line interface).
      *
-     * @param options
+     * @param argv
      */
     public Config(String[] argv)
     {
@@ -239,12 +239,7 @@ public void setGraphvizDir(File graphvizDir) {
 
     /**
      * Return the path to Graphviz (used to find the dot executable to run to
-     * generate ER diagrams).<p/>
-     *
-     * Returns {@link #getDefaultGraphvizPath()} if a specific Graphviz path
-     * was not specified.
-     *
-     * @return
+     * generate ER diagrams).
      */
     public File getGraphvizDir() {
         if (graphvizDir == null) {
@@ -795,10 +790,10 @@ public boolean isEncodeCommentsEnabled() {
 
     /**
      * If enabled we'll attempt to query/render the number of rows that
-     * each table contains.<p/>
-     *
+     * each table contains.
+     * <p>
      * Defaults to <code>true</code> (enabled).
-     *
+     * </p>
      * @param enabled
      */
     public void setNumRowsEnabled(boolean enabled) {
@@ -817,10 +812,10 @@ public boolean isNumRowsEnabled() {
     }
 
     /**
-     * If enabled we'll include views in the analysis.<p/>
-     *
+     * If enabled we'll include views in the analysis.
+     * <p>
      * Defaults to <code>true</code> (enabled).
-     *
+     * </p>
      * @param enabled
      */
     public void setViewsEnabled(boolean enabled) {
@@ -840,8 +835,10 @@ public boolean isViewsEnabled() {
 
     /**
      * Returns <code>true</code> if metering should be embedded in
-     * the generated pages.<p/>
+     * the generated pages.
+     * <p>
      * Defaults to <code>false</code> (disabled).
+     * </p>
      * @return
      */
     public boolean isMeterEnabled() {
@@ -883,7 +880,7 @@ public Pattern getColumnExclusions() {
      * Set the columns to exclude from relationship diagrams where the specified
      * columns aren't directly referenced by the focal table.
      *
-     * @param columnExclusions regular expression of the columns to
+     * @param fullColumnExclusions regular expression of the columns to
      *        exclude
      */
     public void setIndirectColumnExclusions(String fullColumnExclusions) {
@@ -942,7 +939,7 @@ public Pattern getTableInclusions() {
 
     /**
      * Set the tables to exclude as a regular expression
-     * @param tableInclusions
+     * @param tableExclusions
      */
     public void setTableExclusions(String tableExclusions) {
         this.tableExclusions = Pattern.compile(tableExclusions);
@@ -997,10 +994,12 @@ public List<String> getSchemas() {
 
     /**
      * Set the name of the {@link SqlFormatter SQL formatter} class to use to
-     * format SQL into HTML.<p/>
+     * format SQL into HTML.
+     * <p>
      * The implementation of the class must be made available to the class
      * loader, typically by specifying the path to its jar with <em>-dp</em>
      * ({@link #setDriverPath(String)}).
+     * </p>
      */
     public void setSqlFormatter(String formatterClassName) {
         sqlFormatterClass = formatterClassName;
@@ -1232,7 +1231,8 @@ public boolean isLowQuality() {
     }
 
     /**
-     * Set the level of logging to perform.<p/>
+     * Set the level of logging to perform.
+     * <p>
      * The levels in descending order are:
      * <ul>
      *  <li><code>severe</code> (highest - least detail)
@@ -1243,7 +1243,7 @@ public boolean isLowQuality() {
      *  <li><code>finer</code>
      *  <li><code>finest</code>  (lowest - most detail)
      * </ul>
-     *
+     * </p>
      * @param logLevel
      */
     public void setLogLevel(String logLevel) {
@@ -1314,7 +1314,7 @@ public void setHasOrphans(boolean hasOrphans) {
     }
 
     /**
-     * @see #setHasOrphans()
+     * @see #setHasOrphans(boolean)
      *
      * @return
      */
@@ -1330,7 +1330,7 @@ public void setHasRoutines(boolean hasRoutines) {
     }
 
     /**
-     * @see #setHasRoutines()
+     * @see #setHasRoutines(boolean)
      *
      * @return
      */
@@ -1358,8 +1358,6 @@ public Properties getDbProperties() throws InvalidConfigurationException {
 
     /**
      * Determines the database properties associated with the specified type.
-     * A call to {@link #setDbProperties(Properties)} is expected after determining
-     * the complete set of properties.
      *
      * @param type
      * @return

src/main/java/net/sourceforge/schemaspy/model/EmptySchemaException.java

@@ -26,11 +26,6 @@
 public class EmptySchemaException extends RuntimeException {
     private static final long serialVersionUID = 1L;
 
-    /**
-     * When a message is sufficient
-     *
-     * @param msg
-     */
     public EmptySchemaException() {
         super();
     }

src/main/java/net/sourceforge/schemaspy/model/ForeignKeyConstraint.java

@@ -165,15 +165,15 @@ public List<TableColumn> getChildColumns() {
     /**
      * Returns the delete rule for this constraint.
      *
-     * @see {@link java.sql.DatabaseMetaData#importedKeyCascade}
+     * @see java.sql.DatabaseMetaData#importedKeyCascade
      */
     public int getDeleteRule() {
         return deleteRule;
     }
 
     /**
      * Returns <code>true</code> if this constraint should
-     * <a href='http://en.wikipedia.org/wiki/Cascade_delete'>cascade deletions</code>.
+     * <a href='http://en.wikipedia.org/wiki/Cascade_delete'>cascade deletions</a>.
      *
      * @return
      */
@@ -255,7 +255,7 @@ public String getDeleteRuleAlias() {
     /**
      * Returns the update rule for this constraint.
      *
-     * @see {@link java.sql.DatabaseMetaData#importedKeyCascade}
+     * @see java.sql.DatabaseMetaData#importedKeyCascade
      */
     public int getUpdateRule() {
         return updateRule;

src/main/java/net/sourceforge/schemaspy/model/RemoteTable.java

@@ -52,8 +52,6 @@ public RemoteTable(Database db, String catalog, String schema, String name, Stri
     /**
      * Connect to the PK's referenced by this table that live in the original schema
      * @param tables
-     * @param excludeIndirectColumns
-     * @param excludeColumns
      * @throws SQLException
      */
     @Override

src/main/java/net/sourceforge/schemaspy/model/Table.java

@@ -168,15 +168,14 @@ public void addCheckConstraint(String constraintName, String text) {
     }
 
     /**
-     * @param rs ResultSet from {@link DatabaseMetaData#getImportedKeys(String, String, String)}
+     * rs ResultSet from {@link DatabaseMetaData#getImportedKeys(String, String, String)}
      * rs.getString("FK_NAME");
      * rs.getString("FKCOLUMN_NAME");
      * rs.getString("PKTABLE_CAT");
      * rs.getString("PKTABLE_SCHEM");
      * rs.getString("PKTABLE_NAME");
      * rs.getString("PKCOLUMN_NAME");
      * @param tables Map
-     * @param db
      * @throws SQLException
      */
     protected void addForeignKey(String fkName, String fkColName,
@@ -683,8 +682,10 @@ public List<TableColumn> getColumns() {
     }
 
     /**
-     * Returns <code>true</code> if this table references no other tables..<p/>
+     * Returns <code>true</code> if this table references no other tables.
+     * <p>
      * Used in dependency analysis.
+     * </p>
      * @return
      */
     public boolean isRoot() {
@@ -698,8 +699,10 @@ public boolean isRoot() {
     }
 
     /**
-     * Returns <code>true</code> if this table is referenced by no other tables.<p/>
+     * Returns <code>true</code> if this table is referenced by no other tables.
+     * <p>
      * Used in dependency analysis.
+     * </p>
      * @return
      */
     public boolean isLeaf() {
@@ -904,7 +907,7 @@ public int getNumNonImpliedParents() {
     /**
      * Remove one foreign key constraint.
      *
-     * <p/>Used during dependency analysis phase.
+     * <p>Used during dependency analysis phase.</p>
      *
      * @return
      */
@@ -997,9 +1000,7 @@ public void setNumRows(long numRows) {
      *
      * returns -1 if unable to successfully fetch the row count
      *
-     * @param db Database
-     * @return int
-     * @throws SQLException
+     * @return long
      */
     protected long fetchNumRows() {
         if (isView() || isRemote())
@@ -1123,7 +1124,7 @@ public void update(TableMeta tableMeta) {
     }
 
     /**
-     * Same as {@link #connectForeignKeys(Map, Database, Properties)},
+     * Same as {@link #connectForeignKeys(Map)},
      * but uses XML-based metadata
      *
      * @param tableMeta
@@ -1213,12 +1214,12 @@ public boolean isOrphan(boolean withImpliedRelationships) {
 
     /**
      * Compare this table to another table.
-     * Results are based on 1: identity, 2: table name, 3: schema name<p/>
-     *
+     * Results are based on 1: identity, 2: table name, 3: schema name
+     * <p>
      * This implementation was put in place to deal with analyzing multiple
      * schemas that contain identically named tables.
-     *
-     * @see {@link Comparable#compareTo(Object)}
+     * </p>
+     * @see Comparable#compareTo(Object)
      */
     public int compareTo(Table other) {
         if (other == this)  // fast way out

src/main/java/net/sourceforge/schemaspy/util/HtmlEncoder.java

@@ -51,7 +51,7 @@ public static String encodeToken(char ch) {
 
     /**
      * Returns an HTML-encoded equivalent of the specified tokenized string,
-     * where tokens such as '<', '>', '\n' and '\r' have been isolated from
+     * where tokens such as '&lt;', '&gt;', '\n' and '\r' have been isolated from
      * other tokens.
      *
      * @param str

src/main/java/net/sourceforge/schemaspy/view/DefaultSqlFormatter.java

@@ -155,7 +155,6 @@ protected Map<String, Table> getTableMap(Database db)
      * keyed by several possible ways to refer to the table.
      *
      * @param tables
-     * @param dbName
      * @return
      */
     protected Map<String, Table> getTableMap(Collection<? extends Table> tables) {

src/main/java/net/sourceforge/schemaspy/view/DotConnectorFinder.java

@@ -45,7 +45,6 @@ public static DotConnectorFinder getInstance() {
     /**
      *
      * @param table Table
-     * @throws IOException
      * @return Set of <code>dot</code> relationships (as {@link DotConnector}s)
      */
     public Set<DotConnector> getRelatedConnectors(Table table, boolean includeImplied) {
@@ -63,7 +62,6 @@ public Set<DotConnector> getRelatedConnectors(Table table, boolean includeImplie
      *
      * @param table1 Table
      * @param table2 Table
-     * @throws IOException
      * @return Set of <code>dot</code> relationships (as {@link DotConnector}s)
      */
     public Set<DotConnector> getRelatedConnectors(Table table1, Table table2, boolean includeExcluded, boolean includeImplied) {