Merge branch 'GT-3362_ryanmkurtz_PR-1287_astrelsky_DocumentationFixes'

Conflicts:
	Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java

Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationIdentifier.java

@@ -26,7 +26,9 @@ package ghidra.framework;
  * converted to all uppercase.  Both will have spaces removed from their names.
  * <p>
  * Examples:
+ * <ul>
  * <li>ghidra-7.4_DEV
+ * </ul>
  */
 public class ApplicationIdentifier {
 

Ghidra/Framework/Utility/src/main/java/ghidra/framework/ApplicationVersion.java

@@ -24,9 +24,11 @@ package ghidra.framework;
  * part of the version is disregarded in the {@link #compareTo(ApplicationVersion)} method).
  * <p>
  * Examples:
+ * <ul>
  * <li>7.4
  * <li>7.4.1
  * <li>7.4.1-BETA
+ * </ul>
  */
 public class ApplicationVersion implements Comparable<ApplicationVersion> {
 

Ghidra/Framework/Utility/src/main/java/ghidra/util/Swing.java

@@ -138,9 +138,9 @@ public class Swing {
 	 * <p>Use this method when you are not on the Swing thread and you need to get a value 
 	 * that is managed/synchronized by the Swing thread.
 	 *
-	 * <pre>
+	 * <pre>{@literal
 	 * 		String value = runNow(() -> label.getText());
-	 * </pre>
+	 * }</pre>
 	 *
 	 * @param s the supplier that will be called on the Swing thread
 	 * @return the result of the supplier

Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java

@@ -203,9 +203,9 @@ public class SystemUtilities {
 	 * {@link SwingUtilities#invokeAndWait(Runnable)}.  Use this method when you need to get
 	 * a value while being on the Swing thread.
 	 *
-	 * <pre>
+	 * <pre>{@literal
 	 * 		String value = runSwingNow(() -> label.getText());
-	 * </pre>
+	 * }</pre>
 	 *
 	 * @param s the supplier that will be called on the Swing thread
 	 * @return the result of the supplier

Ghidra/Framework/Utility/src/main/java/ghidra/util/exception/AssertException.java

@@ -1,6 +1,5 @@
 /* ###
  * IP: GHIDRA
- * REVIEWED: YES
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,8 +49,8 @@ public class AssertException extends RuntimeException {
     /**
      * Create a new AssertException with the given message.
      *
-     * @param msg the exception message.
-     * @param t the Throwable which caused this exception to be generated.
+     * @param message the exception message.
+     * @param throwable the Throwable which caused this exception to be generated.
      */
     public AssertException( String message, Throwable throwable ) {
     	super( message, throwable );

Ghidra/Framework/Utility/src/main/java/ghidra/util/task/TaskMonitor.java

@@ -80,7 +80,7 @@ public interface TaskMonitor {
 	 * Set the progress maximum value
 	 * <p><b>
 	 * Note: setting this value will reset the progress to be the max if the progress is currently
-	 * greater than the new new max value.
+	 * greater than the new new max value.</b>
 	 * @param max maximum value for progress
 	 */
 	public void setMaximum(long max);

Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java

@@ -353,7 +353,7 @@ public final class FileUtilities {
 	 * <p>
 	 * Throws an {@link IOException} if there is any problem while creating the directory.
 	 * <p>
-	 * Does not create any missing parent directories.  See {@link #checkMkdirs(File)} instead.
+	 * Does not create any missing parent directories.  See {@link #checkedMkdirs(File)} instead.
 	 * <p>
 	 * Takes into account race conditions with external threads/processes
 	 * creating the same directory at the same time.
@@ -499,7 +499,10 @@ public final class FileUtilities {
 	 *
 	 * @param originalDir The directory from which to extract contents
 	 * @param copyDir The directory in which the extracted contents will be placed
-	 * @param fileFilte a filter to apply against the directory's contents
+	 * @param filter a filter to apply against the directory's contents
+	 * @param monitor the task monitor
+	 * @throws IOException if there was a problem accessing the files
+	 * @throws CancelledException if the copy is cancelled
 	 */
 	public final static int copyDir(File originalDir, File copyDir, FileFilter filter,
 			TaskMonitor monitor) throws IOException, CancelledException {
@@ -608,7 +611,7 @@ public final class FileUtilities {
 	/**
 	 * Copy the contents of the specified fromFile to the out stream.
 	 * @param fromFile file data source
-	 * @param toFile destination stream
+	 * @param out destination stream
 	 * @param monitor if specified the progress will be reset and will advance to
 	 * 100% when the copy is complete.
 	  * @throws IOException thrown if there was a problem accessing the files
@@ -714,9 +717,9 @@ public final class FileUtilities {
 	 * <p>
 	 * The file is treated as UTF-8 encoded.
 	 * <p>
-	 * @param is the input stream from which to read
+	 * @param url the input stream from which to read
 	 * @return a list of file lines
-	 * @throws IOException
+	 * @throws IOException thrown if there was a problem accessing the files
 	 */
 	public static List<String> getLines(URL url) throws IOException {
 
@@ -1039,8 +1042,8 @@ public final class FileUtilities {
 	 * no case sensitivity checks are done and the original specified File param is returned
 	 * unchanged.
 	 * <p>
-	 * (Put another way: symlink "FILE1" -> "../path/file2", no case sensitive enforcing can be done,
-	 * but symlink "FILE1" -> "../path/file1" will be enforced by this method.)
+	 * (Put another way: symlink "FILE1" -&gt; "../path/file2", no case sensitive enforcing can be done,
+	 * but symlink "FILE1" -&gt; "../path/file1" will be enforced by this method.)
 	 * <p>
 	 * Querying a filepath that does not exist will result in a 'success' and the caller will
 	 * receive the non-existent File instance back.

Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java

@@ -296,7 +296,7 @@ public class ReflectionUtilities {
 	/**
 	 * Uses the given <tt>patterns</tt> to remove elements from the given stack trace.     
 	 * The current implementation will simply perform a <tt>toString()</tt> on each element and
-	 * then check to see if that string contains any of the </tt>patterns</tt>.
+	 * then check to see if that string contains any of the <tt>patterns</tt>.
 	 * 
 	 * @param trace the trace to filter
 	 * @param patterns the non-regex patterns used to perform a 

Ghidra/Framework/Utility/src/main/java/utility/function/ExceptionalCallback.java

@@ -27,7 +27,7 @@ public interface ExceptionalCallback<E extends Exception> {
 	/**
 	 * The method that will be called
 	 * 
-	 * @throws Exception if the call throws an exception
+	 * @throws E if the call throws an exception
 	 */
 	public void call() throws E;
 }