| "r" |
- * Open for reading only. Invoking any of the write
+ * Access mode permitted values and meanings
+ * Value | Meaning |
|---|
+ * "r" |
+ * Open for reading only. Invoking any of the write
* methods of the resulting object will cause an {@link
* java.io.IOException} to be thrown. |
- * | "rw" |
+ * "rw" |
* Open for reading and writing. If the file does not already
* exist then an attempt will be made to create it. |
- * | "rws" |
- * Open for reading and writing, as with "rw", and also
+ * | "rws" |
+ * Open for reading and writing, as with "rw", and also
* require that every update to the file's content or metadata be
* written synchronously to the underlying storage device. |
- * | "rwd" |
- * Open for reading and writing, as with "rw", and also
+ * | "rwd" |
+ * Open for reading and writing, as with "rw", and also
* require that every update to the file's content be written
* synchronously to the underlying storage device. |
*
@@ -84,8 +84,8 @@ public class GhidraRandomAccessFile {
* @param mode the access mode, as described
* above
* @exception IllegalArgumentException if the mode argument is not equal
- * to one of "r", "rw", "rws", or
- * "rwd"
+ * to one of "r", "rw", "rws", or
+ * "rwd"
* @exception FileNotFoundException
* that name cannot be created, or if some other error occurs
* while opening or creating the file
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessOptions.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessOptions.java
index d1a7dabd73..d5f09682ba 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessOptions.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessOptions.java
@@ -318,7 +318,7 @@ public class HeadlessOptions {
/**
* This method can be used to enable recursive processing of files during
- * -import or -process modes. In order for recursive processing of files to
+ * -import or -process modes. In order for recursive processing of files to
* occur, the user must have specified a directory (and not a specific file)
* for the Headless Analyzer to import or process.
*
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessScript.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessScript.java
index 5718bf5ae7..66c742d80f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessScript.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessScript.java
@@ -35,28 +35,28 @@ public abstract class HeadlessScript extends GhidraScript {
*/
public enum HeadlessContinuationOption {
/**
- * Continue running scripts and/or analysis; -import and -process
+ * Continue running scripts and/or analysis; -import and -process
* modes complete normally.
*/
CONTINUE,
/**
* Continue running scripts and/or analysis;
- * -import mode does not save program,
- * -process mode deletes program.
+ * -import mode does not save program,
+ * -process mode deletes program.
*/
CONTINUE_THEN_DELETE,
/**
* Abort any scripts or analysis that come after this script;
- * -import mode does not save program, -process mode deletes program.
+ * -import mode does not save program, -process mode deletes program.
*/
ABORT_AND_DELETE,
/**
- * Abort any scripts or analysis that come after this script; -import mode does
+ * Abort any scripts or analysis that come after this script; -import mode does
* save program (but it may not be processed completely),
- * -process mode completes normally, minus scripts or analysis that
+ * -process mode completes normally, minus scripts or analysis that
* runs after the ABORT request.
*/
ABORT
@@ -285,7 +285,7 @@ public abstract class HeadlessScript extends GhidraScript {
*
*
* Then the following usage would ensure that any files imported after this call would
- * be saved in the MyGhidraProject:/dir1/innerDir2 folder.
+ * be saved in the MyGhidraProject:/dir1/innerDir2 folder.
*
* setHeadlessImportDirectory("dir1/innerDir2");
*
@@ -330,8 +330,8 @@ public abstract class HeadlessScript extends GhidraScript {
* If a file with the same name already exists in the desired location, it will only be
* overwritten if "-overwrite" is true.
*
- * This method is only applicable when using the HeadlessAnalyzer -import mode and
- * is ineffective in -process mode.
+ * This method is only applicable when using the HeadlessAnalyzer -import mode and
+ * is ineffective in -process mode.
*
* @param importDir the absolute path (relative to root) where inputs will be saved
* @throws ImproperUseException if not in headless mode or headless instance not set
@@ -372,7 +372,7 @@ public abstract class HeadlessScript extends GhidraScript {
*
* Analysis will time out only in the case where:
*
- * - the users has set an analysis timeout period using the -analysisTimeoutPerFile
+ *
- the users has set an analysis timeout period using the
-analysisTimeoutPerFile
* parameter
* - analysis is enabled and has completed
* - the current script is being run as a postScript (since postScripts run after
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/navigation/GoToQuery.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/navigation/GoToQuery.java
index f13c2edf2e..21ea4d5ed6 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/navigation/GoToQuery.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/navigation/GoToQuery.java
@@ -559,9 +559,9 @@ public class GoToQuery {
//==================================================================================================
/**
- * A class to maintain our collection of open programs and to provide an Iterator
+ * A class to maintain our collection of open programs and to provide an
Iterator
* when we need to process the collection. The {@link #iterator()} method has a side-effect
- * of putting the current program at the front of the Iterator so that the current
+ * of putting the current program at the front of the Iterator so that the current
* program is always searched first when processing the collection of programs.
*/
protected class ProgramGroup implements Iterable {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/BoundedBufferedReader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/BoundedBufferedReader.java
index eda277e84b..52cf576279 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/BoundedBufferedReader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/BoundedBufferedReader.java
@@ -125,7 +125,7 @@ public class BoundedBufferedReader extends Reader {
* Reads a single character.
*
* @return The character read, as an integer in the range 0 to 65535 (
- * 0x00-0xffff), or -1 if the end of the stream has been
+ * 0x00-0xffff), or -1 if the end of the stream has been
* reached
* @exception IOException
* If an I/O error occurs
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldMouseHandler.java
index 029ef6917c..f2609da96e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldMouseHandler.java
@@ -38,7 +38,7 @@ public interface FieldMouseHandler {
* @param mouseEvent The mouse event that triggered the click
* @param serviceProvider A service provider used to access system resources.
* @return true if this handler wishes to have exclusive handling rights to processing the
- * clickedObject
+ * clickedObject
* @see ListingField#getClickedObject(ghidra.util.bean.field.FieldLocation)
*/
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
index 02b4cae29e..3e97704001 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRL.java
@@ -39,10 +39,10 @@ import ghidra.util.SystemUtilities;
* Examples (pipes shown in red since they are hard to see):
*
* - file://dir/subdir -- simplest example, locates a file on local computer filesystem.
- *
- file://dir/subdir/example.zip|zip://readme.txt -- points to a file named "readme.txt" in a zip file.
- *
- file://dir/subdir/example.zip|zip://dir/nested.tar|tar://file.txt -- points to
+ *
- file://dir/subdir/example.zip|zip://readme.txt -- points to a file named "readme.txt" in a zip file.
+ *
- file://dir/subdir/example.zip|zip://dir/nested.tar|tar://file.txt -- points to
* a file inside a TAR archive, which is inside a ZIP archive, which is on the local filesystem.
- *
- file://dir/subdir/example.zip?MD5=1234567|zip://readme.txt?MD5=987654 --
+ *
- file://dir/subdir/example.zip?MD5=1234567|zip://readme.txt?MD5=987654 --
* points to a file named "readme.txt" (with a MD5 hash) in a zip file (that has another
* MD5 hash).
*
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java b/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java
index 8c1678b6dc..0c38d8cde0 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/flatapi/FlatProgramAPI.java
@@ -600,7 +600,7 @@ public class FlatProgramAPI {
* starting from the address. If the start address is null, then the find will start
* from the minimum address of the program.
*
- * The byteString may contain regular expressions. The following
+ * The byteString may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
*
* "\\x80" - A basic search pattern for a byte value of 0x80
@@ -629,7 +629,7 @@ public class FlatProgramAPI {
* the given byte string, starting from the address. If the start address is null, then the
* find will start from the minimum address of the program.
*
- * The byteString may contain regular expressions. The following
+ * The byteString may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
*
* "\\x80" - A basic search pattern for a byte value of 0x80
@@ -655,7 +655,7 @@ public class FlatProgramAPI {
* the given byte string, starting from the address. If the start address is null, then the
* find will start from the minimum address of the program.
*
- * The byteString may contain regular expressions. The following
+ * The byteString may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
*
* "\\x80" - A basic search pattern for a byte value of 0x80
@@ -699,7 +699,7 @@ public class FlatProgramAPI {
*
* Note: The ranges within the addressSet are NOT treated as a contiguous set when searching
*
- * The byteString may contain regular expressions. The following
+ * The byteString may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
*
* "\\x80" - A basic search pattern for a byte value of 0x80
@@ -731,7 +731,7 @@ public class FlatProgramAPI {
* treated as a contiguous set when searching.
*
*
- * The byteString may contain regular expressions. The following
+ * The byteString may contain regular expressions. The following
* highlights some example search strings (note the use of double backslashes ("\\")):
*
* "\\x80" - A basic search pattern for a byte value of 0x80
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractGhidraHeadlessIntegrationTest.java b/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractGhidraHeadlessIntegrationTest.java
index 14b3b69cad..33e39dd9dd 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractGhidraHeadlessIntegrationTest.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractGhidraHeadlessIntegrationTest.java
@@ -130,7 +130,7 @@ public abstract class AbstractGhidraHeadlessIntegrationTest extends AbstractDock
/**
* Creates an in-memory program with the given language
* @param name the program name
- * @param languageString a language string of the format x86:LE:32:default
+ * @param languageString a language string of the format x86:LE:32:default
* @param consumer a consumer for the program
* @return a new program
* @throws Exception if there is any issue creating the language
@@ -148,7 +148,7 @@ public abstract class AbstractGhidraHeadlessIntegrationTest extends AbstractDock
/**
* Creates an in-memory program with the given language
* @param name the program name
- * @param languageString a language string of the format x86:LE:32:default
+ * @param languageString a language string of the format x86:LE:32:default
* @param compilerSpecID the ID
* @param consumer a consumer for the program
* @return a new program
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractProgramBasedTest.java b/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractProgramBasedTest.java
index 8c267a3a36..6af97d9d11 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractProgramBasedTest.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/AbstractProgramBasedTest.java
@@ -38,7 +38,7 @@ import utility.function.ExceptionalFunction;
* This class will create for you a tool, a {@link TestEnv} and will open the program
* specified by {@link #getProgramName()}.
*
- * To use this class, you must call {@link #initialize()} from your test or setUp
+ * To use this class, you must call {@link #initialize()} from your test or setUp
* method.
*
* Note: if you are loading a pre-existing program, then simply override
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/TestEnv.java b/Ghidra/Features/Base/src/main/java/ghidra/test/TestEnv.java
index e03dc96785..e9c458225d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/TestEnv.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/TestEnv.java
@@ -67,7 +67,7 @@ public class TestEnv {
/**
* Used to perform emergency cleanup. Tests are expected to call {@link #dispose()} in
- * their tearDown method. This is here to catch the case where the is some fatal
+ * their tearDown method. This is here to catch the case where the is some fatal
* error that prevents that from taking place.
*/
private static Set instances = new HashSet<>();
@@ -362,7 +362,7 @@ public class TestEnv {
* @param ghidraClass The class of the dialog the user desires
* @param maxTimeMS The max amount of time in milliseconds to wait for the requested dialog
* to appear.
- * @return The first occurrence of a dialog that extends the given ghirdraClass
+ * @return The first occurrence of a dialog that extends the given ghirdraClass
* @deprecated use instead {@link AbstractDockingTest#waitForDialogComponent(Class)}
*/
@Deprecated
@@ -480,7 +480,7 @@ public class TestEnv {
/**
* This method differs from {@link #launchDefaultTool()} in that this method does not set the
- * tool variable in of this TestEnv instance.
+ * tool variable in of this TestEnv instance.
* @return the tool
*/
public PluginTool createDefaultTool() {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/AbstractSelectionNavigationAction.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/AbstractSelectionNavigationAction.java
index 1a985ad94c..d529581276 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/AbstractSelectionNavigationAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/AbstractSelectionNavigationAction.java
@@ -32,7 +32,7 @@ import ghidra.util.HelpLocation;
import resources.Icons;
/**
- *
+ *
* An action used to trigger navigation callback on instances of {@link JTable}. Users can
* toggle this action to control navigation that is based upon selection.
*
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java
index b8c74054c2..0c7c98046f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/GhidraTable.java
@@ -34,7 +34,7 @@ import ghidra.program.util.ProgramSelection;
* Navigation is only supported if the underlying table model
* implements ProgramTableModel and the setGoToService() method
* has been called with a valid reference. When both of these conditions are met, then the
- * table will navigate on a user's double-click or on an Enter key press. Also, if
+ * table will navigate on a user's double-click or on an Enter key press. Also, if
* selection navigation is enabled, then this table will navigate any time the selection of
* the table changes. To prevent this feature call
* {@link #setNavigateOnSelectionEnabled(boolean)} with a value of false.
@@ -175,7 +175,7 @@ public class GhidraTable extends GTable {
/**
* Does nothing if no {@link GoToService} has been installed from
* {@link #installNavigation(GoToService, Navigatable)}. Also, this method will do
- * nothing if this table's TableModel is not an instance of {@link ProgramTableModel}.
+ * nothing if this table's TableModel is not an instance of {@link ProgramTableModel}.
* Otherwise, this method will attempt to go to the program location denoted by the
* given row and column.
*
@@ -212,7 +212,7 @@ public class GhidraTable extends GTable {
* to go to the program location denoted by the given row and column.
*
* This method differs from {@link #navigate(int, int)} in that this method will not
- * navigate if {@link #navigateOnSelection} is false.
+ * navigate if {@link #navigateOnSelection} is false.
*/
private void navigateOnCurrentSelection(int row, int column) {
if (!navigateOnSelection) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/ProgramLocationTableRowMapper.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/ProgramLocationTableRowMapper.java
index 550a72eb37..8e62bf3919 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/ProgramLocationTableRowMapper.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/ProgramLocationTableRowMapper.java
@@ -34,7 +34,7 @@ import docking.widgets.table.*;
*
* This interface is an ExtensionPoint so that once created, they will be ingested automatically
* by Ghidra. Once discovered, these mappers will be used to provide dynamic columns to to
- * tables with row types that match ROW_TYPE.
+ * tables with row types that match ROW_TYPE.
*
* This column is an extension of {@link TableRowMapper} that has knowledge of
* {@link ProgramLocationTableColumn}s, which means that it knows how to generate
diff --git a/Ghidra/Features/Base/src/main/java/help/screenshot/AbstractScreenShotGenerator.java b/Ghidra/Features/Base/src/main/java/help/screenshot/AbstractScreenShotGenerator.java
index 78a658574a..ac16d28dc1 100644
--- a/Ghidra/Features/Base/src/main/java/help/screenshot/AbstractScreenShotGenerator.java
+++ b/Ghidra/Features/Base/src/main/java/help/screenshot/AbstractScreenShotGenerator.java
@@ -1364,7 +1364,7 @@ public abstract class AbstractScreenShotGenerator extends AbstractGhidraHeadedIn
* screen coordinates. This allows you to capture a sub-component of a UI, drawing
* rectangles around children of said sub-component.
*
- * If you are unsure of what to pass for root, the call
+ * If you are unsure of what to pass for root, the call
* {@link #drawRectangleAround(JComponent, Color, int)} instead.
*
* @param component the component to be en-rectangled
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java b/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java
index c561d1f6de..3deb7fc1fc 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java
@@ -28,7 +28,7 @@ import docking.action.DockingActionIf;
* toolbar buttons and menu items will enable and disable as the user interacts with the system.
* Further, popup menu items will not be added to popup menus when they report false for
* {@link DockingActionIf#isAddToPopup(ActionContext)}; they will appear in the popup, but be
- * disabled if they report true for the above call, but false for
+ * disabled if they report true for the above call, but false for
* {@link DockingActionIf#isEnabledForContext(ActionContext)}.
* When the user executes an action, the current context will be passed to the backing
* {@link DockingActionIf}. Ultimately, context serves to control action enablement and to
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
index 820c198ad2..5499012d81 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
@@ -175,7 +175,7 @@ public abstract class ComponentProvider implements HelpDescriptor, ActionContext
public abstract JComponent getComponent();
/**
- * A method that allows children to set the instanceID to a desired value (useful for
+ * A method that allows children to set the instanceID to a desired value (useful for
* restoring saved IDs).
*
* Note: this can be called only once during the lifetime of the calling instance; otherwise, an
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DialogComponentProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/DialogComponentProvider.java
index 642c4cb8ac..211749d103 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/DialogComponentProvider.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/DialogComponentProvider.java
@@ -1002,7 +1002,7 @@ public class DialogComponentProvider
/**
* Sets the button to make "Default" when the dialog is shown. If no default button is
- * desired, then pass null as the button value.
+ * desired, then pass null as the button value.
* @param button the button to make default enabled.
*/
public void setDefaultButton(JButton button) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
index dfbfdfcfb3..6c8a888f04 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
@@ -148,7 +148,7 @@ public class DockingUtils {
/**
* Checks if the mouseEvent has the "control" key down. On windows, this is actually
- * the control key. On Mac, it is the command key.
+ * the control key. On Mac, it is the command key.
*
* @param mouseEvent the event to check
* @return true if the control key is pressed
@@ -161,7 +161,7 @@ public class DockingUtils {
/**
* Checks if the mouseEvent has the "control" key down. On windows, this is actually
- * the control key. On Mac, it is the command key.
+ * the control key. On Mac, it is the command key.
*
* @param keyEvent the event to check
* @return true if the control key is pressed
@@ -307,16 +307,16 @@ public class DockingUtils {
*
* Notes
* Historically, to make a component transparent you would call
- * {@link JComponent#setOpaque(boolean)} with a false value. However, it turns out
- * that the definition and the implementation of this method are at odds. setOpaque(false)
+ * {@link JComponent#setOpaque(boolean)} with a false value. However, it turns out
+ * that the definition and the implementation of this method are at odds. setOpaque(false)
* is meant to signal that some part of the component is transparent, so the parent component
* needs to be painted. Most LaFs implemented this by not painting the background of the
* component, but used the parent's color instead. The Nimbus LaF actually honors the
- * contract of setOpaque(), which has the effect of painting the components
+ * contract of setOpaque(), which has the effect of painting the components
* background by default.
*
* This method allows components to achieve transparency when they used to
- * rely on setOpaque(false).
+ * rely on setOpaque(false).
*
* @param c the component to be made transparent
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java b/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java
index dbc11b5a04..b4c9aca2f6 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/DockingWindowManager.java
@@ -219,11 +219,11 @@ public class DockingWindowManager implements PropertyChangeListener, Placeholder
}
/**
- * A convenience method for getting the window for component and then calling
+ * A convenience method for getting the window for component and then calling
* {@link #getInstanceForWindow(Window)}.
* @param component The component for which to get the associated {@link DockingWindowManager}
* instance.
- * @return The {@link DockingWindowManager} instance associated with component
+ * @return The {@link DockingWindowManager} instance associated with component
*/
public static synchronized DockingWindowManager getInstance(Component component) {
Window window = WindowUtilities.windowForComponent(component);
@@ -726,7 +726,7 @@ public class DockingWindowManager implements PropertyChangeListener, Placeholder
* Hides or shows the component associated with the given provider.
*
* Note: This method will not show the given provider if it has not previously been
- * added via addComponent(...).
+ * added via addComponent(...).
*
* @param provider the provider of the component to be hidden or shown.
* @param visibleState true to show the component, false to hide it.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
index 7be392989b..50011444ed 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
@@ -33,7 +33,7 @@ import ghidra.util.exception.AssertException;
* processing. See {@link #dispatchKeyEvent(KeyEvent)} for a more detailed explanation of how
* Ghidra processes key events.
*
- * {@link #install()} must be called in order to install this Singleton into Java's
+ * {@link #install()} must be called in order to install this Singleton into Java's
* key event processing system.
*/
public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher {
@@ -98,9 +98,9 @@ public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher
* There are some exceptions to this processing chain:
*
* - We don't do any processing when the focused component is an instance of
- * JTextComponent.
+ * JTextComponent.
* - We don't do any processing if the active window is an instance of
- * DockingDialog.
+ * DockingDialog.
*
*
* @see java.awt.KeyEventDispatcher#dispatchKeyEvent(java.awt.event.KeyEvent)
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingPrecedence.java b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingPrecedence.java
index 1ae085dad5..07c0b6487a 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingPrecedence.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingPrecedence.java
@@ -19,7 +19,7 @@ package docking;
/**
* An enum that holds the values for order of keybinding precedence, in order from
* highest priority to lowest. For a more detailed description of how Ghidra processes
- * key events see ghidra.KeyBindingOverrideKeyDispatcher.dispatchKeyEvent(KeyEvent)
+ * key events see ghidra.KeyBindingOverrideKeyDispatcher.dispatchKeyEvent(KeyEvent)
*/
public enum KeyBindingPrecedence {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/action/KeyBindingData.java b/Ghidra/Framework/Docking/src/main/java/docking/action/KeyBindingData.java
index dee9dc6a60..947e2e39dd 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/action/KeyBindingData.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/action/KeyBindingData.java
@@ -75,7 +75,7 @@ public class KeyBindingData {
/**
* Updates the given data with system-independent versions of key modifiers. For example,
- * the control key will be converted to the command key on the Mac.
+ * the control key will be converted to the command key on the Mac.
* @param newKeyBindingData the data to validate
* @return the potentially changed data
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java b/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java
index de613c3ac2..2fb2ccabaf 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java
@@ -573,7 +573,7 @@ public class KeyBindingUtils {
/**
* Updates the given data with system-independent versions of key modifiers. For example,
- * the control key will be converted to the command key on the Mac.
+ * the control key will be converted to the command key on the Mac.
*
* @param keyStroke the keystroke to validate
* @return the potentially changed keystroke
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragGestureAdapter.java b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragGestureAdapter.java
index c7a1b1116b..49ac3c1009 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragGestureAdapter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragGestureAdapter.java
@@ -25,7 +25,7 @@ import java.awt.event.InputEvent;
/**
* This class receives notification when the user intitiates a
* drag and drop operation; it is responsible for getting the
- * Transferable and telling the DragSource to
+ * Transferable and telling the DragSource to
* start the drag.
*/
public class DragGestureAdapter implements DragGestureListener {
@@ -44,11 +44,11 @@ public class DragGestureAdapter implements DragGestureListener {
}
/**
- * A DragGestureRecognizer has detected a
+ * A DragGestureRecognizer has detected a
* platform-dependent Drag and Drop action initiating gesture
* and is notifying this Listener in order for it to initiate
* the action for the user.
- * The DragGestureRecognizer hides the platform-specific
+ * The DragGestureRecognizer hides the platform-specific
* events that initate a drag and drop operation.
*
* @param e event describing the gesture that has just occurred
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragSrcAdapter.java b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragSrcAdapter.java
index b305ca42ad..c6cb54d998 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragSrcAdapter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DragSrcAdapter.java
@@ -23,7 +23,7 @@ import java.awt.dnd.*;
* Adapter class that receives notifications in order to
* provide drag over effects.
* When the operation ends, this class receives a
- * dragDropEnd message, and is responsible for
+ * dragDropEnd message, and is responsible for
* checking the success of the operation. If the operation was
* successful, and if it was a Move, then
* this class will remove the source data.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DropTgtAdapter.java b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DropTgtAdapter.java
index b1ff5d1968..ae911d5071 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/dnd/DropTgtAdapter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/dnd/DropTgtAdapter.java
@@ -26,7 +26,7 @@ import java.util.ArrayList;
/**
* Class to handle notifications of drag and drop operations that occur
* on the DropTarget object. The DropTarget is the component that accepts
- * drops during a drag and drop operation. The drop
+ * drops during a drag and drop operation. The drop
* method actually transfers the data.
*/
public class DropTgtAdapter implements DropTargetListener {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpService.java b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpService.java
index 7f10fe2053..dcb896ca6a 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpService.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpService.java
@@ -70,7 +70,7 @@ public interface HelpService {
/**
* Register help for a specific object.
*
- * Do not call this method will a null help location. Instead, to signal that
+ * Do not call this method will a null help location. Instead, to signal that
* an item has no help, call {@link #excludeFromHelp(Object)}.
*
* @param helpObject the object to associate the specified help location with
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/ActionState.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/ActionState.java
index d5a64456ec..4e4f498d15 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/ActionState.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/ActionState.java
@@ -21,9 +21,9 @@ import ghidra.util.HelpLocation;
import ghidra.util.SystemUtilities;
/**
- * Note: this class overrides the equals(Object) and relies upon the equals
- * method of the userData object. Thus, if it is important that equals work for you in
- * the non-standard identity way, then you must override equals in your user data objects.
+ * Note: this class overrides the equals(Object) and relies upon the equals
+ * method of the userData object. Thus, if it is important that equals work for you in
+ * the non-standard identity way, then you must override equals in your user data objects.
*
* @param the type of the action state
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/DockingMenuItemUI.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/DockingMenuItemUI.java
index 95be798eff..e03acac259 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/DockingMenuItemUI.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/DockingMenuItemUI.java
@@ -44,7 +44,7 @@ import docking.util.GraphicsUtils;
*
* [Checkbox][Icon][Menu Item Content][Menu Pull-right/Accelerator Text]
*
- * To display the Menu Item Content in a tabular fashion, use the '\t' character
+ * To display the Menu Item Content in a tabular fashion, use the '\t' character
* to delimit the data into columns. This class will align all menu items in the given menu
* based upon the largest number of columns in the group and the largest width for each column.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuGroupMap.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuGroupMap.java
index 57d5d19712..16f4edff1f 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuGroupMap.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuGroupMap.java
@@ -31,7 +31,7 @@ public class MenuGroupMap {
* Sets the group for the given menuPath
* @param menuPath the menuPath for which to assign a group
* @param group the name of the group for the action with the given menu path
- * @param menuSubGroup the name used for sorting items in the same group. If this
+ * @param menuSubGroup the name used for sorting items in the same group. If this
* value is {@link MenuData#NO_SUBGROUP}, then sorting is based upon the name of the
* menu item.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiActionDockingAction.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiActionDockingAction.java
index 639b605076..6b30ae56d4 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiActionDockingAction.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiActionDockingAction.java
@@ -75,8 +75,8 @@ public abstract class MultiActionDockingAction extends DockingAction
}
/**
- * By default a click on this action will trigger actionPerformed() to be called.
- * You can call this method to disable that feature. When called with false, this
+ * By default a click on this action will trigger actionPerformed() to be called.
+ * You can call this method to disable that feature. When called with false, this
* method will effectively let the user click anywhere on the button or its drop-down arrow
* to show the popup menu. During normal operation, the user can only show the popup by
* clicking the drop-down arrow.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiStateDockingAction.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiStateDockingAction.java
index 468a934ca0..dc411e78ea 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiStateDockingAction.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultiStateDockingAction.java
@@ -99,9 +99,9 @@ public abstract class MultiStateDockingAction extends DockingAction {
public abstract void actionStateChanged(ActionState newActionState, EventTrigger trigger);
/**
- * If doPerformAction is true, then, when the user clicks the
+ * If doPerformAction is true, then, when the user clicks the
* button and not the drop-down arrow, the {@link #doActionPerformed(ActionContext)}
- * method will be called. If doPerformAction is false, then, when
+ * method will be called. If doPerformAction is false, then, when
* the user clicks the button and not the drop-down arrow, the popup menu will be shown, just
* as if the user had clicked the drop-down arrow.
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultipleActionDockingToolbarButton.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultipleActionDockingToolbarButton.java
index 01694e76ae..8409488aed 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/MultipleActionDockingToolbarButton.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/MultipleActionDockingToolbarButton.java
@@ -75,8 +75,8 @@ public class MultipleActionDockingToolbarButton extends EmptyBorderButton {
}
/**
- * By default a click on this button will trigger actionPerformed() to be called.
- * You can call this method to disable that feature. When called with false, this
+ * By default a click on this button will trigger actionPerformed() to be called.
+ * You can call this method to disable that feature. When called with false, this
* method will effectively let the user click anywhere on the button or its drop-down arrow
* to show the popup menu. During normal operation, the user can only show the popup by
* clicking the drop-down arrow.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java b/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java
index 7b5ba78afe..ade9a16fbc 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java
@@ -258,8 +258,8 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
}
/**
- * Waits for a window with the given name. If parentWindow is not null, then it
- * will be used to find subordinate windows. If parentWindow is null, then all
+ * Waits for a window with the given name. If parentWindow is not null, then it
+ * will be used to find subordinate windows. If parentWindow is null, then all
* existing frames will be searched.
*
* @param parentWindow The parent of the window for which to search, or null to search all
@@ -364,7 +364,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
* Check for and display message component text associated with
* ErrLogDialog and OptionDialog windows.
* @param w any window
- * @return the message string if one can be found; null otherwise
+ * @return the message string if one can be found; null otherwise
*/
public static String checkMessageDisplay(Window w) {
Component c = findComponentByName(w, "MESSAGE-COMPONENT");
@@ -634,7 +634,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
* Waits for the first window of the given class.
*
* @param ghidraClass The class of the dialog the user desires
- * @return The first occurrence of a dialog that extends the given ghirdraClass
+ * @return The first occurrence of a dialog that extends the given ghirdraClass
* @see #waitForDialogComponent(Window, Class, int)
*/
public static T waitForDialogComponent(
@@ -644,13 +644,13 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
/**
* Waits for the first window of the given class. This method assumes that the desired dialog
- * is parented by parentWindow.
+ * is parented by parentWindow.
*
* @param parentWindow The parent of the desired dialog; may be null
* @param clazz The class of the dialog the user desires
* @param timeoutMS The max amount of time in milliseconds to wait for the requested dialog
* to appear.
- * @return The first occurrence of a dialog that extends the given ghirdraClass
+ * @return The first occurrence of a dialog that extends the given ghirdraClass
* @deprecated Instead call one of the methods that does not take a timeout
* (we are standardizing timeouts). The timeouts passed to this method will
* be ignored in favor of the standard value.
@@ -748,7 +748,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
/**
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
- * the given providerClass.
+ * the given providerClass.
*
* @param clazz The class of the ComponentProvider to locate
* @return The component provider, or null if one cannot be found
@@ -778,10 +778,10 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
/**
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
- * the given providerClass. This method will repeat the search every
+ * the given providerClass. This method will repeat the search every
* {@link #DEFAULT_WAIT_DELAY} milliseconds
* until the provider is found, or the maximum number of searches has been reached, where
- * maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY}
+ * maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY}
*
* @param clazz The class of the ComponentProvider to locate
* @return The component provider, or null if one cannot be found
@@ -867,9 +867,9 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
*
* Note: this method assumes the given node is not a RootNode, but a child thereof
*
- * @param node The Node instance that contains the desired ComponentProvider
+ * @param node The Node instance that contains the desired ComponentProvider
* or other nodes.
- * @param providerClass The ComponentProvider class for which to search.
+ * @param providerClass The ComponentProvider class for which to search.
*/
private static ComponentProvider getComponentProviderFromNode(Object node,
Class providerClass) {
@@ -906,10 +906,10 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
/**
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
- * the given providerClass. This method will repeat the search every
+ * the given providerClass. This method will repeat the search every
* {@link #DEFAULT_WAIT_DELAY} milliseconds
* until the provider is found, or the maximum number of searches has been reached, where
- * maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY}
+ * maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY}
*
* @param parentWindow The window that will become the parent window of the provider (this is
* typically the tool's frame).
@@ -1012,7 +1012,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
/**
* Finds the toggle button with the given name inside of the given container and then
- * ensures that the selected state of the button matches selected.
+ * ensures that the selected state of the button matches selected.
*
* Note: this works for any instanceof {@link JToggleButton}, such as:
*
@@ -1049,7 +1049,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
}
/**
- * Ensures that the selected state of the button matches selected.
+ * Ensures that the selected state of the button matches selected.
*
* Note: this works for most toggle button implementations which are derived from
* AbstractButton and relay on {@link AbstractButton#isSelected()} and
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownSelectionTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownSelectionTextField.java
index a9246e4b62..54bc13c11f 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownSelectionTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownSelectionTextField.java
@@ -25,9 +25,9 @@ import javax.swing.ListSelectionModel;
*
* Usage note: Typically this text field will not be used directly, but will
* instead be used indirectly by way of an editor.
- * If this field is used directly, then the user should use {@link #setSelectedValue(Object)} and
- * {@link #getSelectedValue()} to get and set data on this field, rather than calling
- * {@link #setText(String)} and {@link #getText()}.
+ * If this field is used directly, then the user should use {@link #setSelectedValue(Object)} and
+ * {@link #getSelectedValue()} to get and set data on this field, rather than calling
+ * {@link #setText(String)} and {@link #getText()}.
*
* Usage notes:
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownTextFieldDataModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownTextFieldDataModel.java
index 9295dc8ce6..3903a5080e 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownTextFieldDataModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/DropDownTextFieldDataModel.java
@@ -28,7 +28,7 @@ import javax.swing.ListCellRenderer;
public interface DropDownTextFieldDataModel {
/**
- * Returns a list of data that matches the given searchText. A match typically
+ * Returns a list of data that matches the given searchText. A match typically
* means a "startsWith" match. A list is returned to allow for multiple matches.
*
* @param searchText The text used to find matches.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/HyperlinkComponent.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/HyperlinkComponent.java
index f1d77a6887..2bffed45bc 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/HyperlinkComponent.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/HyperlinkComponent.java
@@ -89,8 +89,8 @@ public class HyperlinkComponent extends JPanel {
/**
* Add a listener that will be called whenever hyperlink updates happen (hover, activate, etc).
*
- * @param anchorName The value in the href attribute of the anchor tag.
- * @param listener The listener to be called when the anchor(s) with a matching href is
+ * @param anchorName The value in the href attribute of the anchor tag.
+ * @param listener The listener to be called when the anchor(s) with a matching href is
* manipulated by the user.
*/
public void addHyperlinkListener(String anchorName, HyperlinkListener listener) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java
index e9bba099bb..9977a37e39 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java
@@ -41,10 +41,10 @@ import ghidra.util.exception.AssertException;
* The primary type of
* dialog provided herein is the basic option dialog that allows the user to specify the buttons
* that appear on the dialog. By default, the given option text will appear as a button(s),
- * followed by a Cancel button (you can call the
+ * followed by a Cancel button (you can call the
* {@link #showOptionNoCancelDialog(Component, String, String, String, String, int)} methods if
- * you do not want a Cancel button. To use this type of dialog you can use the
- * various showOptionDialog* methods.
+ * you do not want a Cancel button. To use this type of dialog you can use the
+ * various showOptionDialog* methods.
*
*
* Each of the option dialog methods will return a result, which is a number indicating the
@@ -70,8 +70,8 @@ import ghidra.util.exception.AssertException;
* Yes/No Dialogs
*
*
- * Finally, there are a series of methods that present Yes and No buttons in
- * a dialog. There are versions that do and do not have a Cancel button.
+ * Finally, there are a series of methods that present Yes and No buttons in
+ * a dialog. There are versions that do and do not have a Cancel button.
*
*
*
@@ -789,8 +789,8 @@ public class OptionDialog extends DialogComponentProvider {
/**
* Dialog with only YES/NO options, no CANCEL
*
- * The dialog shown by this method will have the No button set as the default button so
- * that an Enter key press will trigger a No action.
+ * The dialog shown by this method will have the No button set as the default button so
+ * that an Enter key press will trigger a No action.
*
* @param parent The parent component of this dialog. If the given component is
* a frame or dialog, then the component will be used to parent the option dialog.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialogBuilder.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialogBuilder.java
index 8b249c7020..1a0580f9ee 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialogBuilder.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialogBuilder.java
@@ -50,7 +50,7 @@ import ghidra.util.Swing;
* is different than adding an option named "Cancel" which would return a result greater than
* 0, depending on where in the order it was added.
*
- * A "Remember Option" can be added to OptionDialog to
+ * A "Remember Option" can be added to OptionDialog to
* present the user with a choice for remembering a dialog result and automatically
* returning that result instead of showing the dialog or similar dialogs in the future.
* Note that for simple OK dialogs, there really isn't a meaningful result to remember, other
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GhidraComboBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GhidraComboBox.java
index d80b1bc5b2..dcff25daa1 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GhidraComboBox.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/combobox/GhidraComboBox.java
@@ -163,7 +163,7 @@ public class GhidraComboBox extends JComboBox implements GComponent {
* By default Ghidra disables the forwarding altogether, since most users of
* {@link GhidraComboBox} will add an action listener to handle <Enter> actions.
*
- * To re-enable the default behavior, set the forwardEnter value to true.
+ * To re-enable the default behavior, set the forwardEnter value to true.
*
* @param forwardEnter true to enable default <Enter> key handling.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputWithChoicesDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputWithChoicesDialog.java
index f638ff626c..51ae9d7cda 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputWithChoicesDialog.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/InputWithChoicesDialog.java
@@ -41,7 +41,7 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
* can check the value of {@link #isCanceled()} to know whether or not
* the user canceled the operation. To get the user selected value use the
* {@link #getValue()} value(s) entered by the user. If the user cancelled the operation, then
- * null will be returned from getValue().
+ * null will be returned from getValue().
*
*
* @param dialogTitle used as the name of the dialog's title bar
@@ -70,7 +70,7 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
* can check the value of {@link #isCanceled()} to know whether or not
* the user canceled the operation. To get the user selected value use the
* {@link #getValue()} value(s) entered by the user. If the user cancelled the operation, then
- * null will be returned from getValue().
+ * null will be returned from getValue().
*
*
* @param dialogTitle used as the name of the dialog's title bar
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FieldElement.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FieldElement.java
index 3ed9d5165e..6703717268 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FieldElement.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FieldElement.java
@@ -39,7 +39,7 @@ public interface FieldElement {
/**
* Returns the length of the text within this element. This is a convenience method for
- * calling getText().length().
+ * calling getText().length().
* @return the length of the text within this element.
*/
public int length();
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldRange.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldRange.java
index af911ef861..d7124969ce 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldRange.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldRange.java
@@ -26,8 +26,8 @@ import org.jdom.Element;
* end row (exclusive).
*
* Conceptually, this class can be thought of as a range of rows (defined by
- * startIndex and endindex) with sub-positions within those rows (defined by
- * startField and endField). As an example, consider a text select that begins on
+ * startIndex and endindex) with sub-positions within those rows (defined by
+ * startField and endField). As an example, consider a text select that begins on
* some word in a row and ends on another word in a different row.
*/
public class FieldRange implements Comparable {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filter/FilterTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filter/FilterTextField.java
index 1bcfba73c6..6ec44132ee 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filter/FilterTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filter/FilterTextField.java
@@ -63,7 +63,7 @@ public class FilterTextField extends JPanel {
private WeakSet enterListeners = WeakDataStructureFactory.createCopyOnWriteWeakSet();
/**
- * Constructs this text field with the given component. component may be null, but
+ * Constructs this text field with the given component. component may be null, but
* then this field will be unable to flash in response to focus events (see the header
* documentation).
*
@@ -75,7 +75,7 @@ public class FilterTextField extends JPanel {
/**
* Constructs this text field with the given component and the preferred visible column
- * width. component may be null, but then this field will be able to flash in
+ * width. component may be null, but then this field will be able to flash in
* response to focus events (see the header documentation).
* @param component The component needed to listen for focus changes, may be null.
* @param columns The number of preferred visible columns (see JTextField)
@@ -164,15 +164,15 @@ public class FilterTextField extends JPanel {
*
* Note: this method will not perform the alert if the minimum time between alerts
* has not passed. To force the alter to take place, call {@link #alert(boolean)} with a
- * value of true.
+ * value of true.
*/
public void alert() {
alert(false);
}
/**
- * This is the same as {@link #alert()} with the exception that a true value for
- * forceAlter will guarantee that the alert will happen. A false value
+ * This is the same as {@link #alert()} with the exception that a true value for
+ * forceAlter will guarantee that the alert will happen. A false value
* will not perform the alert if the minimum time between alerts has not passed.
* @param forceAlert true signals to force the alter to take place.
* @see #alert()
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractSortedTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractSortedTableModel.java
index 88c901c0ca..9353174ac2 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractSortedTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/AbstractSortedTableModel.java
@@ -270,7 +270,7 @@ public abstract class AbstractSortedTableModel extends AbstractGTableModel
/**
* A default sort method that uses the {@link Collections#sort(List, Comparator)} method for
* sorting. Implementors with reasonably sized data sets can rely on this method. For data
- * sets that can become large, the ThreadedTableModel is the recommended base class,
+ * sets that can become large, the ThreadedTableModel is the recommended base class,
* as it handles loading/sorting/filtering in a threaded way.
*
* @param data The data to be sorted
@@ -303,7 +303,7 @@ public abstract class AbstractSortedTableModel extends AbstractGTableModel
/**
* Fires an event to let the listeners (like JTable) know that things have been changed.
- * This method exists so that subclasses have a way to call the various tableChanged()
+ * This method exists so that subclasses have a way to call the various tableChanged()
* methods without triggering this class's overridden version.
* @param dataChanged True signals that the actual data has changed; false signals that the
* data is the same, with exception that attributes of that data may be different.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DiscoverableTableUtils.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DiscoverableTableUtils.java
index ebae93f2b5..252e8eedea 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DiscoverableTableUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DiscoverableTableUtils.java
@@ -81,23 +81,23 @@ public class DiscoverableTableUtils {
/**
* Returns all "discovered" {@link AbstractDynamicTableColumn} classes that are compatible with the
* given class, which represents the object for a table's row. For example, many tables use
- * Address as the row type. In this case, passing Address.class as the
+ * Address as the row type. In this case, passing Address.class as the
* parameter to this method will return all {@link AbstractDynamicTableColumn}s that can provide column
- * data by working with Address instances.
+ * data by working with Address instances.
*
* Usage Notes: This class will not only discover {@link AbstractDynamicTableColumn}s
* that directly support the given class type, but will also use discovered
* {@link TableRowMapper} objects to create adapters that allow the
* use of table row data that does not exactly match the supported type of discovered
* {@link AbstractDynamicTableColumn} classes. For example, suppose that a table's row type is
- * Address. This methods will return at least all {@link AbstractDynamicTableColumn}s
- * that support Address data. In order to support extra columns, Ghidra has
- * created a {@link TableRowMapper} that can convert a ProgramLocation into an
- * Address. This method will find and use this mapper to return a
+ * Address. This methods will return at least all {@link AbstractDynamicTableColumn}s
+ * that support Address data. In order to support extra columns, Ghidra has
+ * created a {@link TableRowMapper} that can convert a ProgramLocation into an
+ * Address. This method will find and use this mapper to return a
* {@link MappedTableColumn} instance (which is an {@link AbstractDynamicTableColumn}). By doing
- * this, any table that has Address objects as its row type can now use
- * {@link AbstractDynamicTableColumn}s that support ProgramLocations in addition to
- * Address objects. These mappers provide a way for tables that have non-standard
+ * this, any table that has Address objects as its row type can now use
+ * {@link AbstractDynamicTableColumn}s that support ProgramLocations in addition to
+ * Address objects. These mappers provide a way for tables that have non-standard
* Ghidra data as their row type to take advantage of existing dynamic columns for standard
* Ghidra data (like ProgramLocations and Addresses).
*
@@ -129,7 +129,7 @@ public class DiscoverableTableUtils {
}
/**
- * If the given DynamicTableColumn is a match for the given rowTypeClass, then
+ * If the given DynamicTableColumn is a match for the given rowTypeClass, then
* it will be added to the given list.
*
* Implementation Notes:
@@ -149,7 +149,7 @@ public class DiscoverableTableUtils {
* @param rowTypeClass The class of the table's row data (with the same type as
* COLUMN_ROW_TYPE)
* @param tableColumn The column to add to the given collection if it supports the
- * given rowTypeClass.
+ * given rowTypeClass.
*/
@SuppressWarnings("unchecked")
// Each cast is checked below (see notes)
@@ -192,13 +192,13 @@ public class DiscoverableTableUtils {
/**
* Returns a {@link TableRowMapper} for the given class types if one is found. The
- * returned mapper will know how to translate instances of fromType to
- * toType.
+ * returned mapper will know how to translate instances of fromType to
+ * toType.
*
* @param The type of row that is defined by the table
* @param The type of row object that is desired
- * @param fromType The Class object of the given row type
- * @param toType The Class object of the desired row type
+ * @param fromType The Class object of the given row type
+ * @param toType The Class object of the desired row type
* @return a new TableRowMapper
*/
@SuppressWarnings({ "unchecked" }) // we verified before casting
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GDynamicColumnTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GDynamicColumnTableModel.java
index 61e74f1ba4..f00144b826 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GDynamicColumnTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GDynamicColumnTableModel.java
@@ -38,7 +38,7 @@ import utilities.util.reflection.ReflectionUtilities;
* made visible through the UI.
*
* This model will also discover other system columns that understand how to render
- * ROW_TYPE data directly. Also, if you create a {@link TableRowMapper mapper}(s) for
+ * ROW_TYPE data directly. Also, if you create a {@link TableRowMapper mapper}(s) for
* your row type, then this model will load columns for each type for which a mapper was created,
* all as optional, hidden columns.
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTable.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTable.java
index 174e65c954..9a3af2f084 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTable.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTable.java
@@ -236,7 +236,7 @@ public class GTable extends JTable {
}
/**
- * Returns the {@link SelectionManager} in use by this GTable. null is returned
+ * Returns the {@link SelectionManager} in use by this GTable. null is returned
* if the user has installed their own {@link ListSelectionModel}.
*
* @return the selection manager
@@ -880,7 +880,7 @@ public class GTable extends JTable {
*
* - Wrap tooltip text content with an <html> tag so that it is possible for
* the content to be formatted in a manner that is easier for the user read, and
- * - Enable any default {@link GTableCellRenderer} instances to render
+ *
- Enable any
default {@link GTableCellRenderer} instances to render
* HTML content, which they do not do by default.
*
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java
index f3e3454326..3fe377c0c6 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableFilterPanel.java
@@ -62,7 +62,7 @@ import utility.function.Callback;
* Filter Reminder
* The filter text will flash as the table (by default) gains focus. This is done to remind the
* user that the data has been filtered. To change the component that triggers the flashing use
- * {@link #setFocusComponent(Component)}, where the Component parameter is the
+ * {@link #setFocusComponent(Component)}, where the Component parameter is the
* component that will trigger focus flashing when it gains focus. To disable focus flashing,
* pass in null to {@link #setFocusComponent(Component)}.
*
@@ -74,7 +74,7 @@ import utility.function.Callback;
*
* Important Usage Notes
*
- * - You must translate row values retrieved from the table using
+ *
- You must translate row values retrieved from the table using
* this panel.
*
* Since this class wraps the given table with a new model, you must use this class to
@@ -82,15 +82,15 @@ import utility.function.Callback;
* code snippet below will give the incorrect value:
*
* JTable table = ...
- * int selectedRowNumber = table.getSelectedRow();
+ * int selectedRowNumber = table.getSelectedRow();
*
* Instead, you must translate the returned value from above, as in the following snippet:
*
* JTable table = ...
- *
+ *
* int selectedRowNumber = table.getSelectedRow();
* int modelRowNumber = tableFilterPanel.getModelRow( selectedRowNumber ); // see {@link #getModelRow(int)}
- *
+ *
*
*
* - This class may set a new model on the given table, which can affect how tables are sized.
@@ -904,7 +904,7 @@ public class GTableFilterPanel extends JPanel {
* multiple instances created in the same place will cause them all to share the same key and
* thus to have the same filter settings when they are created initially.
*
- * As an example, consider a plugin that creates n providers. If each provider uses
+ * As an example, consider a plugin that creates n providers. If each provider uses
* a filter panel, then each provider will share the same filter settings when that provider
* is created. If this is not what you want, then you need to override this method to
* generate a unique key for each provider.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java
index f399cc4075..7aff12e175 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java
@@ -28,7 +28,7 @@ import javax.swing.table.TableColumnModel;
/**
* A GUI that provides a filterable table. You are required to provide the method names
- * of T that should be used to create columns in the table.
+ * of T that should be used to create columns in the table.
*
* @param the row object type that will be in the table
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectFilterModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectFilterModel.java
index 734bc49be6..fa80e6dd59 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectFilterModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectFilterModel.java
@@ -36,7 +36,7 @@ public interface RowObjectFilterModel extends RowObjectTableModelThe downside of this is that we cache data for every completed filter. So, in a
* degenerate case, with a large dataset, with many incremental filtering steps, where each
* did not significantly reduce the previous set of data, the table could then consume
- * a large amount of memory, roughly equal to allData.size() * numberOfFilterSteps
+ * a large amount of memory, roughly equal to allData.size() * numberOfFilterSteps
*
* Most tables do not have enough data for this to have a significant impact.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectTableModel.java
index eb723d4f07..1aa9c60b37 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/RowObjectTableModel.java
@@ -59,7 +59,7 @@ public interface RowObjectTableModel extends TableModel {
* Note: the index returned is always the 'view' index. For non-filtering table models,
* the 'view' and the 'model' index are the same. However, for filtering table models,
* the 'view' may be a subset of the 'model' index. Thus, it is possible, if this model
- * is a filtering model, that the given t may not have a row value for the current
+ * is a filtering model, that the given t may not have a row value for the current
* state of the model (i.e., when the model is filtered in the view. If you really need to
* get the model index in such a situation, see {@link RowObjectFilterModel}.
*
@@ -74,7 +74,7 @@ public interface RowObjectTableModel extends TableModel {
* filtering, this will be the filtered version of the data. Furthermore, the data should be
* the underlying data and not a copy, as this method will potentially sort the given data.
*
- * For those subclasses using an array, you may use the Arrays class to create
+ * For those subclasses using an array, you may use the Arrays class to create
* a list backed by the array ({@link Arrays#asList(Object...)}).
* @return the model data.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/TableRowMapper.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/TableRowMapper.java
index e4bbe3e384..56a08b6810 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/TableRowMapper.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/TableRowMapper.java
@@ -30,7 +30,7 @@ import utilities.util.reflection.ReflectionUtilities;
*
* This interface is an ExtensionPoint so that once created, they will be ingested automatically
* by Ghidra. Once discovered, these mappers will be used to provide dynamic columns to to
- * tables with row types that match ROW_TYPE.
+ * tables with row types that match ROW_TYPE.
*
* @param The row type of a given table model
* @param The row type expected by dynamic columns.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/VariableColumnTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/VariableColumnTableModel.java
index 8b6e88a639..b469d25198 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/VariableColumnTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/VariableColumnTableModel.java
@@ -52,7 +52,7 @@ public interface VariableColumnTableModel extends TableModel {
* Gets the count of the default columns for this model. This model may have non-default
* columns added. This method will return the count of columns that have been setup
* specifically by the table model. This method can be used to iterate of the first
- * n columns of this model in order to get information for the default columns by
+ * n columns of this model in order to get information for the default columns by
* calling methods like {@link #getColumnName(int)}.
*
* @return Gets the count of the default columns for this model.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AbstractColumnConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AbstractColumnConstraintEditor.java
index bdfe2d49ed..f92a10765b 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AbstractColumnConstraintEditor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AbstractColumnConstraintEditor.java
@@ -85,7 +85,7 @@ public abstract class AbstractColumnConstraintEditor implements ColumnConstra
*
* Subclasses should override this method if they choose to provide a
* detailed constraint editor. This is an optional feature, and this implementation
- * returns null to satisfy the ColumnConstraintEditor contract.
+ * returns null to satisfy the ColumnConstraintEditor contract.
*
* @see #getDetailComponent()
* @return the editors detail component; null in this implementation
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/ColumnConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/ColumnConstraintEditor.java
index ed595d3e12..911c1e46ee 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/ColumnConstraintEditor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/ColumnConstraintEditor.java
@@ -73,7 +73,7 @@ public interface ColumnConstraintEditor {
/**
* If the editor contains and invalid value, this message should indicate
- * why the value is invalid. Only called if hasValidValue() returns false.
+ * why the value is invalid. Only called if hasValidValue() returns false.
* @return an error message, or an empty string if no error
*/
public String getErrorMessage();
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/EnumConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/EnumConstraintEditor.java
index 34e5e83257..580f51a3fc 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/EnumConstraintEditor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/EnumConstraintEditor.java
@@ -93,8 +93,8 @@ public class EnumConstraintEditor> extends AbstractColumnConst
* name for a value; this attempts to locate one such function within the Enum class.
*
* This searches the enum class for a zero-argument, String-returning method called
- * getName(), getDisplayName(), or getDisplayString()
- * before falling back to toString().
+ * getName(), getDisplayName(), or getDisplayString()
+ * before falling back to toString().
*
* @return a more user-friendly name for the value
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/MappedColumnConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/MappedColumnConstraintEditor.java
index f21eb23d96..f82716780d 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/MappedColumnConstraintEditor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/MappedColumnConstraintEditor.java
@@ -66,7 +66,7 @@ public class MappedColumnConstraintEditor implements ColumnConstraintEdito
}
/**
- * Sets the T-converted-to-W type in the delegate editor
+ * Sets the T-converted-to-W type in the delegate editor
*
* {@inheritDoc}
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/NullTableFilter.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/NullTableFilter.java
index 4875b7098c..c33d76a615 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/NullTableFilter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/NullTableFilter.java
@@ -19,7 +19,7 @@ import docking.widgets.table.TableFilter;
/**
* A table filter that represents the state of having no filter. This allows us to not have to
- * use null to have multiple meanings.
+ * use null to have multiple meanings.
*
* @param the type of the row of the table model using this filter
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
index 90730e7de7..08f09b1ab7 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
@@ -46,7 +46,7 @@ import ghidra.util.task.TaskMonitor;
* are no add/removes in the list, then that step does nothing.
*
* Before the job completes, new calls to sort and filter can be called. If the job is past the
- * stage of the new call, the monitor is cancelled, causing the current stage to abort.
+ * stage of the new call, the monitor is cancelled, causing the current stage to abort.
* The next state of this job is set to the appropriate state for the call, the monitor is
* reset, and the job begins executing the next stage, based upon the new call.
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
index 7b72a04705..3c34063ab6 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
@@ -74,9 +74,9 @@ public abstract class ThreadedTableModel
* This variable can be in one of three states:
*
* - null - signals that there is no filter change taking place
- * - An instance of NullTableFitler - the client has removed the current
+ *
- An instance of
NullTableFitler - the client has removed the current
* filter by calling {@link #setTableFilter(TableFilter)} with a null value
- * - An instance of a custom TableFitler - the client has changed the
+ *
- An instance of a custom
TableFitler - the client has changed the
* filter to a non-null value by calling {@link #setTableFilter(TableFilter)}
*
*/
@@ -406,7 +406,7 @@ public abstract class ThreadedTableModel
/**
* Override this to change how filtering is performed. This implementation will do nothing
- * if a TableFilter has not been set via a call to {@link #setTableFilter(TableFilter)}.
+ * if a TableFilter has not been set via a call to {@link #setTableFilter(TableFilter)}.
*
*
* @param data The list of data to be filtered.
@@ -463,7 +463,7 @@ public abstract class ThreadedTableModel
}
/**
- * Sets the given TableFitler on this model. This table filter will then be used
+ * Sets the given TableFitler on this model. This table filter will then be used
* by this model in the default {@link #doFilter(List, TableSortingContext, TaskMonitor)}
* method.
* @param tableFitler The filter to use for table filtering.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModelStub.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModelStub.java
index e97f39895e..3d3be45577 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModelStub.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModelStub.java
@@ -23,7 +23,7 @@ import ghidra.util.task.TaskMonitor;
* A version of {@link ThreadedTableModel} for clients that do not need a DATA_SOURCE.
*
*
- * Note: this class will change a null value for the {@link ServiceProvider} parameter
+ * Note: this class will change a null value for the {@link ServiceProvider} parameter
* to a stubbed version. If your model needs a real service provider, then you can pass a
* non-null value.
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java
index 685fad41dc..18303c8b30 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java
@@ -319,7 +319,7 @@ public class GTree extends JPanel implements BusyListener {
* state.
*
* Note: See the usage note at the header of this class concerning how tree state
- * is used relative to the equals() method.
+ * is used relative to the equals() method.
* @return the saved state
*/
public GTreeState getTreeState() {
@@ -335,7 +335,7 @@ public class GTree extends JPanel implements BusyListener {
* state object.
*
* Note: See the usage note at the header of this class concerning how tree state
- * is used relative to the equals() method.
+ * is used relative to the equals() method.
*
* @param state the state to restore
*
@@ -1025,7 +1025,7 @@ public class GTree extends JPanel implements BusyListener {
}
/**
- * Passing a value of false signals to disable the {@link JTree}'s default behavior
+ * Passing a value of false signals to disable the {@link JTree}'s default behavior
* of showing handles for leaf nodes until they are opened.
*
* @param enable False to disable the default JTree behavior
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeNode.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeNode.java
index cf98ee930c..fd94b35057 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeNode.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeNode.java
@@ -45,15 +45,15 @@ import util.CollectionUtils;
* - getIcon()
*
*
- * Usage Notes:
+ * Usage Notes:
*
- * - The equals() method: The GTree has the ability to remember expanded and
+ *
- The
equals() method: The GTree has the ability to remember expanded and
* selected states. This will only work if the nodes in the saved state can be matched
- * with the nodes in the GTree. Java will do this by using the equals() method.
- * There is a potential problem with this usage. If nodes within the GTree get rebuilt (
+ * with the nodes in the GTree. Java will do this by using the equals() method.
+ * There is a potential problem with this usage. If nodes within the GTree get rebuilt (
* i.e., new nodes are created), then, by default, the expanded and selected state
- * feature will be unable to find the correct nodes, since the default equals()
- * method on GTreeNode performs a comparison based upon instances. To fix this problem,
+ * feature will be unable to find the correct nodes, since the default equals()
+ * method on GTreeNode performs a comparison based upon instances. To fix this problem,
* the {@link #equals(Object)} method has been implemented such that nodes are considered equal if they have
* the same name. The {@link #hashCode()} method will return the hash of the name. The name
* attribute was chosen because it should be the most unique and descriptive piece of information
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/docking/settings/IntegerSignednessFormattingModeSettingsDefinition.java b/Ghidra/Framework/Docking/src/main/java/ghidra/docking/settings/IntegerSignednessFormattingModeSettingsDefinition.java
index 92d945712a..090e1ba6e4 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/docking/settings/IntegerSignednessFormattingModeSettingsDefinition.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/docking/settings/IntegerSignednessFormattingModeSettingsDefinition.java
@@ -73,7 +73,7 @@ public class IntegerSignednessFormattingModeSettingsDefinition implements EnumSe
}
/**
- * Set, or clear if mode is null, the new mode in the provided settings
+ * Set, or clear if mode is null, the new mode in the provided settings
* @param settings settings object
* @param mode new value to assign, or null to clear
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/docking/util/DockingWindowsLookAndFeelUtils.java b/Ghidra/Framework/Docking/src/main/java/ghidra/docking/util/DockingWindowsLookAndFeelUtils.java
index 9342015007..1d9ef7bb95 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/docking/util/DockingWindowsLookAndFeelUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/docking/util/DockingWindowsLookAndFeelUtils.java
@@ -112,8 +112,8 @@ public class DockingWindowsLookAndFeelUtils {
/**
* Set the look and feel (LAF) indicated by the string passed in as a parameter.
* The string value can be either the class name of the LAF, as returned by
- * LookAndFeelInfo.getClassName() or the name as returned by
- * LookAndFeelInfo.getName().
+ * LookAndFeelInfo.getClassName() or the name as returned by
+ * LookAndFeelInfo.getName().
*
* Note: to be effective, this call needs to be made before any components have been created
* and shown.
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskBuilder.java b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskBuilder.java
index cb9fdca552..c769a6506c 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskBuilder.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskBuilder.java
@@ -141,7 +141,7 @@ public class TaskBuilder {
}
/**
- * Sets whether this task reports progress. The default is true.
+ * Sets whether this task reports progress. The default is true.
*
* @param hasProgress true if the task reports progress
* @return this builder
@@ -152,7 +152,7 @@ public class TaskBuilder {
}
/**
- * Sets whether the task can be cancelled. The default is true.
+ * Sets whether the task can be cancelled. The default is true.
*
* @param canCancel true if the task can be cancelled.
* @return this builder
@@ -163,7 +163,7 @@ public class TaskBuilder {
}
/**
- * Sets the component over which the task dialog will be shown. The default is null,
+ * Sets the component over which the task dialog will be shown. The default is null,
* which shows the dialog over the active window.
*
* @param parent the parent
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskLauncher.java b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskLauncher.java
index 2f767830c6..ab2491f48d 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskLauncher.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskLauncher.java
@@ -28,7 +28,7 @@ import ghidra.util.Swing;
* {@link #TaskLauncher(Task, Component, int, int)}. Alternatively, for simpler uses,
* see one of the many static convenience methods.
*
- * Modal Usage
+ * Modal Usage
* Most clients of this class should not be concerned with where
* the dialog used by this class will appear. By default, it will be shown over
* the active window, which is the desired
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskMonitorComponent.java b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskMonitorComponent.java
index bbf5aa97d6..743e150d43 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskMonitorComponent.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/TaskMonitorComponent.java
@@ -267,10 +267,10 @@ public class TaskMonitorComponent extends JPanel implements TaskMonitor {
}
/**
- * Returns true if {@link #setIndeterminate(boolean)} with a value of true has
+ * Returns true if {@link #setIndeterminate(boolean)} with a value of true has
* been called.
*
- * @return true if {@link #setIndeterminate(boolean)} with a value of true has
+ * @return true if {@link #setIndeterminate(boolean)} with a value of true has
* been called.
*/
public boolean isIndeterminate() {
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/cache/CountingBasicFactory.java b/Ghidra/Framework/Generic/src/main/java/generic/cache/CountingBasicFactory.java
index a8fae4d080..c874c11f82 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/cache/CountingBasicFactory.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/cache/CountingBasicFactory.java
@@ -41,8 +41,8 @@ public abstract class CountingBasicFactory implements BasicFactory {
* The method subclass use to create {@link T}s.
*
* @param itemNumber the number of the item being created--
- * one-based; the first item
- * is item 1.
+ * one-based; the first item
+ * is item 1.
* @return a new instance of {@link T}.
* @throws Exception any Exception encountered during creation
*/
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
index 8c4e32c930..21d59e5169 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
@@ -53,23 +53,23 @@ import ghidra.util.task.TaskMonitor;
*
*
* Put Items and Handle Results in Any Order as They Available:
- * {@literal
- * QCallback callback = new AbstractQCallback() {
+ *
+ * {@literal QCallback callback = new AbstractQCallback()} {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
* }
* };
*
- * QItemListener itemListener = new QItemListener() {
- * public void itemProcessed(QResult result) {
- * RESULT result = result.getResult();}
- * // work on my result...{@code
+ * {@literal QItemListener itemListener = new QItemListener()} {
+ * {@literal public void itemProcessed(QResult result)} {
+ * RESULT result = result.getResult();
+ * // work on my result...
* }
* };
*
- * ConcurrentQBuilder builder = new ConcurrentQBuilder();
+ * {@literal ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * }builder.setListener(itemListener);{@code
+ * }builder.setListener(itemListener);
* concurrentQ = builder.build(callback);
* ...
* ...
@@ -77,7 +77,7 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
*
- * }
+ *
*
*
*
@@ -91,7 +91,7 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * }builder.setCollectResults(true);{@code
+ * }builder.setCollectResults(true);{@code
* concurrentQ = builder.getQueue(callback);
* ...
* ...
@@ -99,7 +99,7 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
* ...
- * }{@literal List> results = concurrentQ.waitForResults();}{@literal
+ * }{@literal List> results = concurrentQ.waitForResults();}{@literal
* // process the results...
*
* }
@@ -122,19 +122,19 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * }builder.setQueue(new LinkedBlockingQueue(100));{@literal
+ * }builder.setQueue(new LinkedBlockingQueue(100));{@literal
* concurrentQ = builder.getQueue(callback);
* ...
* ...
* Iterator- iterator =
- * }{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}
+ * }{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}
*
*
*
*
* @param The type of the items to be processed.
* @param The type of objects resulting from processing an item; if you don't care about the
- * return value, then make this value whatever you want, like Object or the
+ * return value, then make this value whatever you want, like Object or the
* same value as {@link I} and return null from {@link QCallback#process(Object, TaskMonitor)}.
*/
public class ConcurrentQ {
@@ -291,12 +291,12 @@ public class ConcurrentQ {
/**
* Allows clients to use a bounded queue (such as a {@link LinkedBlockingQueue} to control
- * how many items get placed into this queue at one time. Calling the add methods
+ * how many items get placed into this queue at one time. Calling the add methods
* will place all items into the queue, which for a large number of items, can consume a
* large amount of memory. This method will block once the queue at maximum capacity,
* continuing to add new items as existing items on the queue are processed.
*
- * To enable blocking on the queue when it is full, construct this ConcurrentQ
+ * To enable blocking on the queue when it is full, construct this ConcurrentQ
* with an instance of {@link BlockingQueue}.
*
* @param iterator An iterator from which items will be taken.
@@ -414,7 +414,7 @@ public class ConcurrentQ {
* exception, then you should instead use {@link #waitForResults()}. That method will return
* all results, both with and without exceptions, which you can then process, including
* checking for exceptions. Note that to use {@link #waitForResults()} to examine exceptions,
- * you must have created this queue with collectResults as true.
+ * you must have created this queue with collectResults as true.
*
* @throws InterruptedException if interrupted while waiting for a result
* @throws Exception any exception encountered while processing an item (this will cancel all
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
index c060a2e6a5..e248f89fea 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
@@ -181,7 +181,7 @@ public class ConcurrentQBuilder {
/**
* @see ConcurrentQ#setMonitor(TaskMonitor, boolean)
*
- * The default value is true.
+ * The default value is true.
*/
public ConcurrentQBuilder setCancelClearsAllJobs(boolean clearAllJobs) {
this.cancelClearsAllJobs = clearAllJobs;
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
index 2beb20a9fa..68dac404c1 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
@@ -24,7 +24,7 @@ import ghidra.util.task.TaskMonitor;
*
* @param The type of the items to be processed.
* @param The type of objects resulting from processing an item; if you don't care about the
- * return value, then make this value whatever you want, like Object or the
+ * return value, then make this value whatever you want, like Object or the
* same value as {@link I} and return null from {@link #process(Object, TaskMonitor) process(I, TaskMonitor)}.
*/
public interface QCallback {
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java b/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
index e3a1f84f56..f3de6c5da5 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
@@ -502,7 +502,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Sets the instance field by the given name on the given object instance.
*
- * Note: if the field is static, then the ownerInstance field can
+ * Note: if the field is static, then the ownerInstance field can
* be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@@ -524,7 +524,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
* Gets the instance field by the given name on the given object instance.
* The value is a primitive wrapper if it is a primitive type.
*
- * Note: if the field is static, then the ownerInstance field can
+ * Note: if the field is static, then the ownerInstance field can
* be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@@ -570,9 +570,9 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Uses reflection to execute the method denoted by the given method name.
* If any value is returned from the method execution, then it will be
- * returned from this method. Otherwise, null is returned.
+ * returned from this method. Otherwise, null is returned.
*
- * Note: if the method is static, then the ownerInstance field can
+ * Note: if the method is static, then the ownerInstance field can
* be the class of the object that contains the method.
*
* @param methodName The name of the method to execute.
@@ -1775,7 +1775,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Creates a file path with a filename that is under the system temp
* directory. The path returned will not point to an existing file. The
- * suffix of the file will be .tmp.
+ * suffix of the file will be .tmp.
*
* @param name the filename
* @return a new file path
@@ -1839,7 +1839,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
* prefix and the given suffix. The final filename will also include the
* current test name, as well as any data added by
* {@link File#createTempFile(String, String)}. The file suffix will be
- * .tmp
+ * .tmp
*
* The file will be marked to delete on JVM exit. This will not work if the
* JVM is taken down the hard way, as when pressing the stop button in
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java b/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java
index 885fdfac32..dabae31d2e 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/test/TestUtils.java
@@ -51,7 +51,7 @@ public class TestUtils {
* Sets the instance field by the given name on the given object
* instance.
*
- * Note: if the field is static, then the ownerInstance field
+ * Note: if the field is static, then the ownerInstance field
* can be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@@ -92,7 +92,7 @@ public class TestUtils {
* Gets the instance field by the given name on the given object
* instance. The value is a primitive wrapper if it is a primitive type.
*
- * Note: if the field is static, then the ownerInstance field
+ * Note: if the field is static, then the ownerInstance field
* can be the class of the object that contains the variable.
*
* @param fieldName The name of the field to retrieve.
@@ -168,9 +168,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
- * will be returned from this method. Otherwise, null is returned.
+ * will be returned from this method. Otherwise, null is returned.
*
- * Note: if the method is static, then the ownerInstance field
+ * Note: if the method is static, then the ownerInstance field
* can be the class of the object that contains the method.
*
* @param methodName The name of the method to execute.
@@ -226,9 +226,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
- * will be returned from this method. Otherwise, null is returned.
+ * will be returned from this method. Otherwise, null is returned.
*
- * Note: if the method is static, then the ownerInstance field
+ * Note: if the method is static, then the ownerInstance field
* can be the class of the object that contains the method.
*
* This method is just a convenience for calling
@@ -264,9 +264,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
- * will be returned from this method. Otherwise, null is returned.
+ * will be returned from this method. Otherwise, null is returned.
*
- * Note: if the method is static, then the ownerInstance field
+ * Note: if the method is static, then the ownerInstance field
* can be the class of the object that contains the method.
*
* If the method you are calling takes no parameters, then call
@@ -305,9 +305,9 @@ public class TestUtils {
/**
* Uses reflection to execute the method denoted by the given method
* name. If any value is returned from the method execution, then it
- * will be returned from this method. Otherwise, null is returned.
+ * will be returned from this method. Otherwise, null is returned.
*
- * Note: if the method is static, then the ownerInstance field
+ * Note: if the method is static, then the ownerInstance field
* can be the class of the object that contains the method.
*
* Warning: The exact class of each arg will be used as the class type
@@ -458,9 +458,9 @@ public class TestUtils {
}
/**
- * Locates the method of the name methodName on the given
+ * Locates the method of the name methodName on the given
* class. If the given class does not contain the method, then this
- * method will recursively call up containingClass's
+ * method will recursively call up containingClass's
* implementation tree looking for a parent implementation of the
* requested method.
*
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java b/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
index 85da8d8dbc..0dfdffcf0a 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
@@ -20,7 +20,7 @@ import java.util.*;
import ghidra.util.exception.AssertException;
/**
- * An iterator that is comprised of one or more {@link PeekableIterator}s. The type T of the
+ * An iterator that is comprised of one or more {@link PeekableIterator}s. The type T of the
* the iterators must either implement {@link Comparable} directly or you must provide a
* {@link Comparator} for comparing the types. Further, it is assumed that the iterators return
* values in sorted order. If the sorted order is reversed, then that must be indicated in
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/util/PeekableIterator.java b/Ghidra/Framework/Generic/src/main/java/generic/util/PeekableIterator.java
index 8dbdb5c2ed..431c6fac2b 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/util/PeekableIterator.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/util/PeekableIterator.java
@@ -27,7 +27,7 @@ public interface PeekableIterator extends Iterator {
/**
* Returns the item that would be returned by calling {@link #next()}, but does not
- * increment the iterator as next would.
+ * increment the iterator as next would.
*
* @return the item that would be returned by calling {@link #next()}
*/
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/util/WindowUtilities.java b/Ghidra/Framework/Generic/src/main/java/generic/util/WindowUtilities.java
index 64145b3e3d..cf32fb7f16 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/util/WindowUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/util/WindowUtilities.java
@@ -217,12 +217,12 @@ public class WindowUtilities {
}
/**
- * Creates a point that is centered over the given parent component, based upon
- * the size of the given child.
+ * Creates a point that is centered over the given parent component, based upon
+ * the size of the given child.
* @param parent The component over which to center the child.
* @param child The component which will be centered over the parent
- * @return a point that is centered over the given parent component, based upon
- * the size of the given child.
+ * @return a point that is centered over the given parent component, based upon
+ * the size of the given child.
*/
public static Point centerOnComponent(Component parent, Component child) {
Dimension parentSize = parent.getSize();
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/util/image/ImageUtils.java b/Ghidra/Framework/Generic/src/main/java/generic/util/image/ImageUtils.java
index 3994a912dd..5d0be478ae 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/util/image/ImageUtils.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/util/image/ImageUtils.java
@@ -269,7 +269,7 @@ public class ImageUtils {
}
/**
- * Writes the given icon out to the file denoted by filename in the PNG format.
+ * Writes the given icon out to the file denoted by filename in the PNG format.
*
* @param icon the icon to write
* @param filename the filename denoting the write destination
@@ -412,13 +412,13 @@ public class ImageUtils {
/**
* Takes in RGB pixel data and then converts the pixel into a gray color with a brightness
- * based upon brightnessPercent.
+ * based upon brightnessPercent.
*
* @param rgbPixels The RGB pixel data for a given pixel.
* @param destination The converted pixel data.
* @param brightnessPercent The amount of brightness to include in the gray value, where 100
* percent is the brightest possible value.
- * @return The destination array filled with the new pixel data.
+ * @return The destination array filled with the new pixel data.
*/
private static int[] filterRgbDisabledImage(int[] rgbPixels, int[] destination,
int brightnessPercent) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
index 7199d4947e..ab6b083c73 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
@@ -579,7 +579,7 @@ public class Application {
* Note: Be sure you understand that there may be multiple application root
* directories in development mode. In general you should not be using this method for
* searching for files yourself, but instead using
- * the various find* methods of this class.
+ * the various find* methods of this class.
*
* @return Returns the application root directory.
* @see #getApplicationRootDirectories()
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/preferences/Preferences.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/preferences/Preferences.java
index 280f0f80fb..5c2289580c 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/preferences/Preferences.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/preferences/Preferences.java
@@ -192,7 +192,7 @@ public class Preferences {
/**
* Get the property with the given name.
*
- * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
+ * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*/
public static String getProperty(String name) {
@@ -208,7 +208,7 @@ public class Preferences {
/**
* Get the property with the given name; if there is no property, return the defaultValue.
*
- * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
+ * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*
* @see #getProperty(String, String, boolean)
@@ -226,10 +226,10 @@ public class Preferences {
/**
* Get the property with the given name; if there is no property, return the defaultValue.
*
- * This version of getProperty will, when useHistoricalValue is true, look
+ * This version of getProperty will, when useHistoricalValue is true, look
* for the given preference value in the last used installation of the application.
*
- * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
+ * Note: all getProperty(...) methods will first check {@link System#getProperty(String)}
* for a value first. This allows users to override preferences from the command-line.
*
* @param name The name of the property for which to get a value
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/CascadedDropTarget.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/CascadedDropTarget.java
index 9143aae3fe..9e627da5fe 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/CascadedDropTarget.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/CascadedDropTarget.java
@@ -117,10 +117,10 @@ public class CascadedDropTarget extends DropTarget {
/**
* Removes the given drop target from anywhere within the tree of CascadedDropTargets.
*
- * If the given dropTarget is an immediate child of this CascadedDropTarget (CDT), then
+ * If the given dropTarget is an immediate child of this CascadedDropTarget (CDT), then
* the other child is returned. Otherwise, a reference to this CDT will be returned with the
- * given dropTarget having been removed from one of this CDT's children. This method
- * effectively removes the given dropTarget from the hierarchy and collapses the tree
+ * given dropTarget having been removed from one of this CDT's children. This method
+ * effectively removes the given dropTarget from the hierarchy and collapses the tree
* structure as needed.
*
* @param dropTarget The target to remove
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/HTMLUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/HTMLUtilities.java
index 77f6dfb9a6..379faaf901 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/HTMLUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/HTMLUtilities.java
@@ -34,7 +34,7 @@ import utilities.util.reflection.ReflectionUtilities;
*
* Many clients use this class to render content as HTML. Below are a few use cases along
* with the method that should be used for each.
- *
+ *
*
* | Use Case | Function | Description |
*
@@ -355,14 +355,14 @@ public class HTMLUtilities {
/**
* Returns the given text wrapped in {@link #LINK_PLACEHOLDER_OPEN} and close tags.
- * If foo is passed for the HTML text, with a content value of 123456, then
+ * If foo is passed for the HTML text, with a content value of 123456, then
* the output will look like:
*
* <!-- LINK CONTENT="123456" -->foo<!-- /LINK -->
*
*
* @param htmlText the HTML text to wrap
- * @param content the value that will be put into the CONTENT section of the
+ * @param content the value that will be put into the CONTENT section of the
* generated HTML. This can later be retrieved by clients transforming this text.
* @return the wrapped text
*/
@@ -375,8 +375,8 @@ public class HTMLUtilities {
/**
* Takes HTML text wrapped by {@link #wrapWithLinkPlaceholder(String, String)} and replaces
- * the custom link comment tags with HTML anchor (A) tags, where the HREF
- * value is the value that was in the CONTENT attribute.
+ * the custom link comment tags with HTML anchor (A) tags, where the HREF
+ * value is the value that was in the CONTENT attribute.
*
* @param text the text for which to replace the markup
* @return the updated text
@@ -428,9 +428,9 @@ public class HTMLUtilities {
/**
* Similar to {@link #toHTML(String)} in that it will wrap the given text in
* HTML tags and split the content into multiple lines. The difference is that this method
- * will split lines that pass the given maximum length and on '\n'
+ * will split lines that pass the given maximum length and on '\n'
* characters. Alternatively, {@link #toHTML(String)} will only split the given
- * text on '\n' characters.
+ * text on '\n' characters.
*
* @param text The text to convert
* @param maxLineLength The maximum number of characters that should appear in a line;
@@ -487,7 +487,7 @@ public class HTMLUtilities {
*
* For example, consider the following
*
- *
+ *
*
* | Input | Output | Rendered as | (Without Friendly Encoding) |
*
@@ -496,10 +496,10 @@ public class HTMLUtilities {
* Hi <b>mom </b>
*
*
- * Hi
- * <b>mom
- * </b>
- *
+ * Hi
+ * <b>mom
+ * </b>
+ *
* |
*
* Hi <b>mom </b>
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/HelpLocation.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/HelpLocation.java
index b6b7af9d00..aed1b5e52f 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/HelpLocation.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/HelpLocation.java
@@ -44,7 +44,7 @@ public class HelpLocation {
* An html file contained within the specified help topic directory must have an Anchor
* defined using the specified anchor name.
*
- * Note: You can specify a null anchor value. In that case, the given topic
+ * Note: You can specify a null anchor value. In that case, the given topic
* will be searched for a file with the same name as the topic. If such a file exists,
* then that file will be used as the file for this location. If no such file exists, then
* the help file to use cannot be resolved. Therefore, it is best to always specify
@@ -62,7 +62,7 @@ public class HelpLocation {
* An html file contained within the specified help topic directory must have an Anchor
* defined using the specified anchor name.
*
- * Note: You can specify a null anchor value. In that case, the given topic
+ * Note: You can specify a null anchor value. In that case, the given topic
* will be searched for a file with the same name as the topic. If such a file exists,
* then that file will be used as the file for this location. If no such file exists, then
* the help file to use cannot be resolved. Therefore, it is best to always specify
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
index d19c0ab9a3..16b48f7a01 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
@@ -497,7 +497,7 @@ public final class NumericUtilities {
/**
* Render number in different bases using the default signedness mode.
* This invokes {@linkplain #formatNumber(long, int, SignednessFormatMode)} with a
- * mode parameter of {@linkplain SignednessFormatMode#DEFAULT}.
+ * mode parameter of {@linkplain SignednessFormatMode#DEFAULT}.
*
* @param number The number to represent
* @param radix the base in which number is represented
@@ -511,29 +511,29 @@ public final class NumericUtilities {
/**
* Provide renderings of number in different bases:
*
- * - 0 - renders
number as an escaped character sequence
- * - 2 - renders
number as a base-2 integer
- * - 8 - renders
number as a base-8 integer
- * - 10 - renders
number as a base-10 integer
- * - 16 (default) - renders
number base-16 integer
+ * -
0 - renders number as an escaped character sequence
+ * -
2 - renders number as a base-2 integer
+ * -
8 - renders number as a base-8 integer
+ * -
10 - renders number as a base-10 integer
+ * -
16 (default) - renders number as a base-16 integer
*
*
- * | Number | Radix | DEFAULT Mode Alias | UNSIGNED Mode Value | SIGNED Mode Value |
|---|
+ * | Number | Radix | DEFAULT Mode Alias | UNSIGNED Mode Value | SIGNED Mode Value |
|---|
* | | | | | |
- * | 100 | 2 | UNSIGNED | 1100100b | 1100100b |
- * | 100 | 8 | UNSIGNED | 144o | 144o |
- * | 100 | 10 | SIGNED | 100 | 100 |
- * | 100 | 16 | UNSIGNED | 64h | 64h |
+ * | 100 | 2 | UNSIGNED | 1100100b | 1100100b |
+ * | 100 | 8 | UNSIGNED | 144o | 144o |
+ * | 100 | 10 | SIGNED | 100 | 100 |
+ * | 100 | 16 | UNSIGNED | 64h | 64h |
* | | | | | |
- * | -1 | 2 | UNSIGNED | 1111111111111111111111111111111111111111111111111111111111111111b | -1b |
- * | -1 | 8 | UNSIGNED | 1777777777777777777777o | -1o |
- * | -1 | 10 | SIGNED | 18446744073709551615 | -1 |
- * | -1 | 16 | UNSIGNED | ffffffffffffffffh | -1h |
+ * | -1 | 2 | UNSIGNED | 1111111111111111111111111111111111111111111111111111111111111111b | -1b |
+ * | -1 | 8 | UNSIGNED | 1777777777777777777777o | -1o |
+ * | -1 | 10 | SIGNED | 18446744073709551615 | -1 |
+ * | -1 | 16 | UNSIGNED | ffffffffffffffffh | -1h |
*| | | | | |
- * | -100 | 2 | UNSIGNED | 1111111111111111111111111111111111111111111111111111111110011100b | -1100100b |
- * | -100 | 8 | UNSIGNED | 1777777777777777777634o | -144o |
- * | -100 | 10 | SIGNED | 18446744073709551516 | -100 |
- * | -100 | 16 | UNSIGNED | ffffffffffffff9ch | -64h |
+ * | -100 | 2 | UNSIGNED | 1111111111111111111111111111111111111111111111111111111110011100b | -1100100b |
+ * | -100 | 8 | UNSIGNED | 1777777777777777777634o | -144o |
+ * | -100 | 10 | SIGNED | 18446744073709551516 | -100 |
+ * | -100 | 16 | UNSIGNED | ffffffffffffff9ch | -64h |
*
* @param number The number to represent
* @param radix The base in which number is represented
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/Saveable.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/Saveable.java
index d55eec5e7d..e6f1d5a0c9 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/Saveable.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/Saveable.java
@@ -48,9 +48,9 @@ public interface Saveable {
* Returns the field classes, in Java types, in the same order as used {@link #save} and
* {@link #restore}.
*
- * For example, if the save method calls objStorage.putInt() and then
- * objStorage.putFloat(), then this method must return
- * Class[]{ Integer.class, Float.class }.
+ * For example, if the save method calls objStorage.putInt() and then
+ * objStorage.putFloat(), then this method must return
+ * Class[]{ Integer.class, Float.class }.
* @return
*/
Class[] getObjectStorageFields();
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/StringUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/StringUtilities.java
index 0af65b0978..e50eec8920 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/StringUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/StringUtilities.java
@@ -309,7 +309,7 @@ public class StringUtilities {
}
/**
- * Returns true if the given string starts with prefix ignoring case.
+ * Returns true if the given string starts with prefix ignoring case.
*
* Note: This method is equivalent to calling:
*
@@ -318,7 +318,7 @@ public class StringUtilities {
*
* @param string the string which may contain the prefix
* @param prefix the prefix to test against
- * @return true if the given string starts with prefix ignoring case.
+ * @return true if the given string starts with prefix ignoring case.
*/
public static boolean startsWithIgnoreCase(String string, String prefix) {
if ((string == null) || (prefix == null)) {
@@ -328,7 +328,7 @@ public class StringUtilities {
}
/**
- * Returns true if the given string ends with postfix, ignoring case.
+ * Returns true if the given string ends with postfix, ignoring case.
*
* Note: This method is equivalent to calling:
*
@@ -336,9 +336,9 @@ public class StringUtilities {
* string.regionMatches( true, startOffset, postfix, 0, postfix.length() );
*
*
- * @param string the string which may end with postfix
+ * @param string the string which may end with postfix
* @param postfix the string for which to test existence
- * @return true if the given string ends with postfix, ignoring case.
+ * @return true if the given string ends with postfix, ignoring case.
*/
public static boolean endsWithIgnoreCase(String string, String postfix) {
if ((string == null) || (postfix == null)) {
@@ -349,11 +349,11 @@ public class StringUtilities {
}
/**
- * Returns true if all the given searches are contained in the given string.
+ * Returns true if all the given searches are contained in the given string.
*
* @param toSearch the string to search
* @param searches the strings to find
- * @return true if all the given searches are contained in the given string.
+ * @return true if all the given searches are contained in the given string.
*/
public static boolean containsAll(CharSequence toSearch, CharSequence... searches) {
if (StringUtils.isEmpty(toSearch) || ArrayUtils.isEmpty(searches)) {
@@ -369,12 +369,12 @@ public class StringUtilities {
}
/**
- * Returns true if all the given searches are contained in the given string,
+ * Returns true if all the given searches are contained in the given string,
* ignoring case.
*
* @param toSearch the string to search
* @param searches the strings to find
- * @return true if all the given searches are contained in the given string.
+ * @return true if all the given searches are contained in the given string.
*/
public static boolean containsAllIgnoreCase(CharSequence toSearch, CharSequence... searches) {
if (StringUtils.isEmpty(toSearch) || ArrayUtils.isEmpty(searches)) {
@@ -838,7 +838,7 @@ public class StringUtilities {
}
/**
- * Limits the given string to the given max number of characters. If the string is
+ * Limits the given string to the given max number of characters. If the string is
* larger than the given length, then it will be trimmed to fit that length after adding
* ellipses
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackKeySet.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackKeySet.java
index a1f859d2b5..761ca911d2 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackKeySet.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackKeySet.java
@@ -640,7 +640,7 @@ public class RedBlackKeySet implements ShortKeySet, Serializable {
}
/**
- * Save the state of the TreeMap instance to a stream (i.e.,
+ * Save the state of the TreeMap instance to a stream (i.e.,
* serialize it).
*
* @serialData The size of the TreeMap (the number of key-value
@@ -665,7 +665,7 @@ public class RedBlackKeySet implements ShortKeySet, Serializable {
}
/**
- * Reconstitute the TreeMap instance from a stream (i.e.,
+ * Reconstitute the TreeMap instance from a stream (i.e.,
* deserialize it).
*/
private void readObject(final java.io.ObjectInputStream s) throws java.io.IOException,
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackLongKeySet.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackLongKeySet.java
index 903ebaa7d2..d915cc3e7e 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackLongKeySet.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackLongKeySet.java
@@ -640,7 +640,7 @@ public class RedBlackLongKeySet implements Serializable {
/**
- * Save the state of the TreeMap instance to a stream (i.e.,
+ * Save the state of the TreeMap instance to a stream (i.e.,
* serialize it).
*
* @serialData The size of the TreeMap (the number of key-value
@@ -668,7 +668,7 @@ public class RedBlackLongKeySet implements Serializable {
/**
- * Reconstitute the TreeMap instance from a stream (i.e.,
+ * Reconstitute the TreeMap instance from a stream (i.e.,
* deserialize it).
*/
private void readObject(final java.io.ObjectInputStream s)
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingUpdateManager.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingUpdateManager.java
index 4603df1ecf..c7ad18b192 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingUpdateManager.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingUpdateManager.java
@@ -34,7 +34,7 @@ import utilities.util.reflection.ReflectionUtilities;
*
* The various methods dictate when the client will get a callback:
*
- * - {@link #update()} - if this is the first call to update, then do the work
+ *
- {@link #update()} - if this is the first call to
update, then do the work
* immediately; otherwise, buffer the update request until the
* timeout has expired.
* - {@link #updateNow()} - perform the callback now.
@@ -93,7 +93,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
*
- * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
+ * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops
@@ -107,7 +107,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
*
- * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
+ * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops
@@ -122,7 +122,7 @@ public class SwingUpdateManager {
/**
* Constructs a new SwingUpdateManager
*
- * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
+ * Note: The minDelay will always be at least {@link #MIN_DELAY_FLOOR}, regardless of
* the given value.
*
* @param minDelay the minimum number of milliseconds to wait once the event stream stops
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/GenericXMLOutputter.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/GenericXMLOutputter.java
index 9ed41a37cd..417f055967 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/GenericXMLOutputter.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/GenericXMLOutputter.java
@@ -21,7 +21,7 @@ import org.jdom.output.XMLOutputter;
import org.jdom.output.Format.TextMode;
/**
- * A simple extension of XMLOutputter that sets default settings to fix common bugs.
+ * A simple extension of XMLOutputter that sets default settings to fix common bugs.
*/
public class GenericXMLOutputter extends XMLOutputter {
diff --git a/Ghidra/Framework/Generic/src/main/java/resources/ResourceManager.java b/Ghidra/Framework/Generic/src/main/java/resources/ResourceManager.java
index fcf34b8264..bb5eeb9750 100644
--- a/Ghidra/Framework/Generic/src/main/java/resources/ResourceManager.java
+++ b/Ghidra/Framework/Generic/src/main/java/resources/ResourceManager.java
@@ -40,7 +40,7 @@ import utility.module.ModuleUtilities;
* General resource management class that provides a convenient
* way of accessing external resources used in Ghidra.
*
- *
+ *
* There is a known problem with Java's {@link MediaTracker} that can cause deadlocks. The various
* methods of this class that create {@link ImageIcon}s will do so by loading image bytes directly,
* as opposed to using the flawed constructor {@link ImageIcon#ImageIcon(Image)}.
@@ -158,10 +158,10 @@ public class ResourceManager {
}
/**
- * Search the classpath for files in the <classpath entry>/dirName
- * location that have the given extension. In null is passed for the
+ * Search the classpath for files in the <classpath entry>/dirName
+ * location that have the given extension. In null is passed for the
* extension, then all files found in the given dir names will be returned. In this
- * way, null is a wildcard.
+ * way, null is a wildcard.
*
* This method differs from {@link #getResource(String)} in that this method finds
* multiple matches.
@@ -181,10 +181,10 @@ public class ResourceManager {
}
/**
- * Search the classpath for files in the <classpath entry>/dirName
- * location that have the given extension. In null is passed for the
+ * Search the classpath for files in the <classpath entry>/dirName
+ * location that have the given extension. In null is passed for the
* extension, then all files found in the given dir names will be returned. In this
- * way, null is a wildcard.
+ * way, null is a wildcard.
*
* The names returned from this method are relative and are meant to be used in a
* later callback to this class for methods such as {@link #loadImage(String)} or
@@ -371,7 +371,7 @@ public class ResourceManager {
}
/**
- * Creates an image icon from the given image. This method will create an ImageIcon
+ * Creates an image icon from the given image. This method will create an ImageIcon
* the "safe" way by avoiding the constructor
* {@link ImageIcon#ImageIcon(Image)}, which can
* trigger problems with Java's {@link MediaTracker}.
diff --git a/Ghidra/Framework/Generic/src/main/java/util/HistoryList.java b/Ghidra/Framework/Generic/src/main/java/util/HistoryList.java
index 428efd385a..f279fbf5c5 100644
--- a/Ghidra/Framework/Generic/src/main/java/util/HistoryList.java
+++ b/Ghidra/Framework/Generic/src/main/java/util/HistoryList.java
@@ -107,7 +107,7 @@ public class HistoryList {
}
/**
- * Adds an item to this history list. null values are ignored.
+ * Adds an item to this history list. null values are ignored.
*
* Calls to this method during selection notification will have no effect. If you need
* to update the history during a notification, then you must do so at a later time, perhaps
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java
index e225088557..4a58588a9b 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GraphAlgorithms.java
@@ -378,7 +378,7 @@ public class GraphAlgorithms {
/**
* Finds all the circuits, or cycles, in the given graph. This version
- * of findCircuits() takes a {@link TimeoutTaskMonitor}, which allows for the
+ * of findCircuits() takes a {@link TimeoutTaskMonitor}, which allows for the
* client to control the duration of work. This is useful for finding paths on very
* large, dense graphs.
*
@@ -401,7 +401,7 @@ public class GraphAlgorithms {
}
/**
- * Finds all paths from start to end in the given graph.
+ * Finds all paths from start to end in the given graph.
*
* Warning: for large, dense graphs (those with many interconnected
* vertices) this algorithm could run indeterminately, possibly causing the JVM to
@@ -425,8 +425,8 @@ public class GraphAlgorithms {
}
/**
- * Finds all paths from start to end in the given graph. This version
- * of findPaths() takes a {@link TimeoutTaskMonitor}, which allows for the
+ * Finds all paths from start to end in the given graph. This version
+ * of findPaths() takes a {@link TimeoutTaskMonitor}, which allows for the
* client to control the duration of work. This is useful for finding paths on very
* large, dense graphs.
*
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/MutableGDirectedGraphWrapper.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/MutableGDirectedGraphWrapper.java
index b5419033e3..1fe6a38afc 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/MutableGDirectedGraphWrapper.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/MutableGDirectedGraphWrapper.java
@@ -33,7 +33,7 @@ import util.CollectionUtils;
* {@link #containsEdge(GEdge)}.
*
* Implementation Note: there is some 'magic' in this class to add 'dummy' vertices to the
- * graph. To facilitate this, the mutated graph in this class does not have the V
+ * graph. To facilitate this, the mutated graph in this class does not have the V
* type, but rather is typed on Object. This means that this class can only be used
* generically, with templated types (like by algorithms and such). Any usage of this class
* that expects concrete implementations to be returned can trigger ClassCastExceptions.
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/ChkDominanceAlgorithm.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/ChkDominanceAlgorithm.java
index 89c32f7d7b..25fcbd1c14 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/ChkDominanceAlgorithm.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/ChkDominanceAlgorithm.java
@@ -28,9 +28,9 @@ import ghidra.util.task.TaskMonitor;
* This algorithm is an implementation of the Cooper, Harvey, Kennedy algorithm.
*
* The algorithm processes the graph in reverse post-order. The runtime of
- * this algorithm is approximately O(V+E*D) per iteration of the loop, where
+ * this algorithm is approximately O(V+E*D) per iteration of the loop, where
* D is the size of the largest dominator set. The number of iterations is
- * bound at d(G) + 3, where d(G) is the "loop
+ * bound at d(G) + 3, where d(G) is the "loop
* connectedness" of the graph.
*
*
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphViewerUtils.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphViewerUtils.java
index 957753e2ae..ae0dd17646 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphViewerUtils.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/GraphViewerUtils.java
@@ -41,7 +41,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
* This class houses various methods for translating location and size data from the various
* graph coordinate spaces.
*
- * Graph Spaces
+ * Graph Spaces
* Size and location information is represented in multiple coordinate spaces, as listed below.
* To translate from one to the other, use {@link GraphViewerUtils}; for example, to see if a
* mouse click is on a given vertex.
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/VisualEdge.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/VisualEdge.java
index 9f381622b2..0a8b68ce86 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/VisualEdge.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/VisualEdge.java
@@ -29,7 +29,7 @@ import ghidra.graph.GEdge;
* separately. A hovered vertex is one that the user moves the mouse over; a focused vertex is
* one that is selected.
*
- *
+ *
* Articulations - The start and end points are always part of the
* edge. Any additional points on the edge are considered articulation points. Thus, an edge
* without articulations will be drawn as a straight line. An edge with articulations will
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualEdgeRenderer.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualEdgeRenderer.java
index 08899fd0d9..d75108ad67 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualEdgeRenderer.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualEdgeRenderer.java
@@ -44,7 +44,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
/**
* Edge render for the {@link VisualGraph} system
*
- * Implementation Notes
+ * Implementation Notes
*
* Jung Vertex/Edge Rendering
* Jung creates shapes for vertices (see {@link VertexShapeFactory}) that are centered. They
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/AbstractVisualGraphLayout.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/AbstractVisualGraphLayout.java
index f0a8e9ed87..0fba3848f2 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/AbstractVisualGraphLayout.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/AbstractVisualGraphLayout.java
@@ -58,7 +58,7 @@ import ghidra.util.task.TaskMonitor;
* {@link #usesEdgeArticulations()} to return true.
*
*
- * By default, this class will create x-position values that
+ * By default, this class will create x-position values that
* are aligned with the column's x-position. You can override
* {@link #getVertexLocation(VisualVertex, Column, Row, Rectangle)} in order to center the
* vertex within its column
diff --git a/Ghidra/Framework/Help/src/main/java/help/GHelpBuilder.java b/Ghidra/Framework/Help/src/main/java/help/GHelpBuilder.java
index ca8cc3bc21..d40205bb97 100644
--- a/Ghidra/Framework/Help/src/main/java/help/GHelpBuilder.java
+++ b/Ghidra/Framework/Help/src/main/java/help/GHelpBuilder.java
@@ -33,11 +33,11 @@ import help.validator.location.HelpModuleCollection;
* module paths and build the help for each module. To build single modules, call this class
* with only one module path.
*
- * Note: Help links must not be absolute. They can be relative, including . and ..
+ * Note: Help links must not be absolute. They can be relative, including . and ..
* syntax. Further, they can use the special help system syntax, which is:
*
- * - help/topics/topicName/Filename.html for referencing help topic files
- *
- help/shared/image.png for referencing image files at paths rooted under
+ *
help/topics/topicName/Filename.html for referencing help topic files
+ * help/shared/image.png for referencing image files at paths rooted under
* the module's root help dir
*
*/
diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/model/AnchorDefinition.java b/Ghidra/Framework/Help/src/main/java/help/validator/model/AnchorDefinition.java
index 1752fa0fea..56f9b2c334 100644
--- a/Ghidra/Framework/Help/src/main/java/help/validator/model/AnchorDefinition.java
+++ b/Ghidra/Framework/Help/src/main/java/help/validator/model/AnchorDefinition.java
@@ -33,11 +33,11 @@ import java.nio.file.Path;
* Warning: The ID generated by this class is specific to the JavaHelp system. It is of
* the format:
*
- * TopicName_anchorName
+ * TopicName_anchorName
*
* or
*
- * TopicName_Filename
+ * TopicName_Filename
*/
public class AnchorDefinition {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolTemplate.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolTemplate.java
index b211aec18c..5ec55f1eca 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolTemplate.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolTemplate.java
@@ -57,7 +57,7 @@ public interface ToolTemplate {
/**
* Get the icon for this tool template. This is equivalent to calling
- * getIconURL().getIcon()
+ * getIconURL().getIcon()
* @return the icon for this tool template.
*/
ImageIcon getIcon();
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/OptionsService.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/OptionsService.java
index 02de3a8681..7628d0453d 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/OptionsService.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/OptionsService.java
@@ -61,9 +61,9 @@ public interface OptionsService {
*
* @param category The category of options to have displayed
* @param filterText An optional value used to filter the nodes visible in the options tree.
- * You may pass null or the empty string "" here if you
+ * You may pass null or the empty string "" here if you
* do not desire filtering.
- * @throws IllegalArgumentException if the given category value does not exist in
+ * @throws IllegalArgumentException if the given category value does not exist in
* the tree of options.
*/
public void showOptionsDialog(String category, String filterText);
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
index 3d4d0f5ccf..26b1ec61a5 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/util/NamespaceUtils.java
@@ -26,13 +26,13 @@ import ghidra.util.exception.*;
/**
* A class to hold utility methods for working with namespaces.
*
- *
+ *
* Example string format:
*
* - global{@link Namespace#NAMESPACE_DELIMITER ::}child1{@link Namespace#NAMESPACE_DELIMITER ::}child2
*
- child1
*
- *
+ *
* Assumptions for creating namespaces from a path string:
*
* - All elements of a namespace path should be namespace symbols and not other
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/map/AddressMap.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/map/AddressMap.java
index 14fda8bdad..3f444c2c75 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/map/AddressMap.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/map/AddressMap.java
@@ -68,10 +68,10 @@ public interface AddressMap {
* @param keyRangeList
* @param addr address or null
* @return index of the keyRange within the keyRangeList which contains addr
- * if it is contained in the list; otherwise, (-(insertion point) - 1).
+ * if it is contained in the list; otherwise,
(-(insertion point) - 1).
* The insertion point is defined as the point at which the
* addr would be inserted into the list: the index of the first keyRange
- * greater than addr, or keyRangeList.size(), if all
+ * greater than addr, or keyRangeList.size(), if all
* keyRanges in the list are less than the specified addr. Note
* that this guarantees that the return value will be >= 0 if
* and only if the addr is found within a keyRange.
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java
index ed8ff2aa7c..4804f1578e 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/ArrayStringable.java
@@ -67,7 +67,7 @@ public interface ArrayStringable extends DataType {
/**
* For cases where an array of this type exists, get the appropriate string to use as the
* default label prefix, taking into account the fact that there exists a reference to the
- * data that references offcutLength bytes into this type
+ * data that references offcutLength bytes into this type
*
* @param buf memory buffer containing the bytes.
* @param settings the Settings object.
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataType.java
index 4bd2a15234..1823aef89c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataType.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataType.java
@@ -230,7 +230,7 @@ public interface DataType {
/**
* Returns the appropriate string to use as the default label prefix, taking into account
* the fact that there exists a reference to the data that references
- * offcutLength bytes into this type
+ * offcutLength bytes into this type
*
* @param buf memory buffer containing the bytes.
* @param settings the Settings object
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/InvalidatedListener.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/InvalidatedListener.java
index f4296ba5b0..f6d2352d50 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/InvalidatedListener.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/InvalidatedListener.java
@@ -22,7 +22,7 @@ package ghidra.program.model.data;
public interface InvalidatedListener {
/**
- * Called when the given dataTypeManager's cache has been invalidated.
+ * Called when the given dataTypeManager's cache has been invalidated.
* @param dataTypeManager The manager whose cache has been invalidated.
*/
public void dataTypeManagerInvalidated(DataTypeManager dataTypeManager);
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
index a8e9943642..f998968ce8 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StructureFactory.java
@@ -47,7 +47,7 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if dataLength is not greater than zero
+ *
- if
dataLength is not greater than zero
* - if the number of components to add exceeds the available
* address space
*
- if there are any instructions in the provided
@@ -72,8 +72,8 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if structureName is null
- *
- if dataLength is not greater than zero
+ *
- if
structureName is null
+ * - if
dataLength is not greater than zero
* - if the number of components to add exceeds the available
* address space
*
- if there are any instructions in the provided
@@ -145,8 +145,8 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if the component at fromPath or the component
- * at toPath are null
+ *
- if the component at
fromPath or the component
+ * at toPath are null
* - if there is not data to add to the structure
*
- if the parent data type is not a structure
*
@@ -175,9 +175,9 @@ public class StructureFactory {
* @return A new structure not yet added to memory.
* @throws IllegalArgumentException for the following conditions:
*
- * - if structureName is null
- *
- if the component at fromPath or the component
- * at toPath are null
+ *
- if
structureName is null
+ * - if the component at
fromPath or the component
+ * at toPath are null
* - if there is not data to add to the structure
*
- if the parent data type is not a structure
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/CodeUnit.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/CodeUnit.java
index 93655c6ec2..8555e33602 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/CodeUnit.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/CodeUnit.java
@@ -237,7 +237,7 @@ public interface CodeUnit extends MemBuffer {
public String[] getCommentAsArray(int commentType);
/**
- * Set the comment for the given comment type. Passing null clears the comment
+ * Set the comment for the given comment type. Passing null clears the comment
*
* @param commentType either EOL_COMMENT, PRE_COMMENT,
* POST_COMMENT, or REPEATABLE_COMMENT
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java
index a1221ed3d2..2ae6a3253c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Listing.java
@@ -197,7 +197,7 @@ public interface Listing {
* Returns an iterator of the code units in this listing (in proper
* sequence), starting at the specified address. The specified address
* indicates the first code unit that would be returned by an initial call
- * to the next method. An initial call to the previous
+ * to the next method. An initial call to the previous
* method would return the code unit with an address less than the specified
* address.
*
@@ -273,7 +273,7 @@ public interface Listing {
* Returns an iterator of the instructions in this listing (in proper
* sequence), starting at the specified address. The specified address
* indicates the first instruction that would be returned by an initial call
- * to the next method. An initial call to the previous
+ * to the next method. An initial call to the previous
* method would return the instruction with an address less than the
* specified address.
*
@@ -347,8 +347,8 @@ public interface Listing {
/**
* Returns an iterator of the data in this listing (in proper sequence),
* starting at the specified address. The specified address indicates the
- * first Data that would be returned by an initial call to the next
- * method. An initial call to the previous method would return the
+ * first Data that would be returned by an initial call to the next
+ * method. An initial call to the previous method would return the
* Data with an address less than the specified address.
*
*
@@ -426,8 +426,8 @@ public interface Listing {
* Returns an iterator of the defined data in this listing (in proper
* sequence), starting at the specified address. The specified address
* indicates the first defined Data that would be returned by an initial
- * call to the next method. An initial call to the
- * previous method would return the defined Data with an address
+ * call to the next method. An initial call to the
+ * previous method would return the defined Data with an address
* less than the specified address.
*
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemBuffer.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemBuffer.java
index e7ca401843..b47f486516 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemBuffer.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/mem/MemBuffer.java
@@ -90,7 +90,7 @@ public interface MemBuffer {
}
/**
- * Reads b.length bytes from this memory buffer
+ * Reads b.length bytes from this memory buffer
* starting at the address of this memory buffer plus the given memoryBufferOffset
* from that position. The actual number of bytes may be fewer
* if bytes can't be read.
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
index c32ab2e7b1..0d415f8820 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java
@@ -245,10 +245,10 @@ public class PcodeDataTypeManager {
}
/**
- * Generate an XML tag describing the given data-type. Most data-types produce a tag,
- * fully describing the data-type. Where possible a tag is produced, which just gives
+ * Generate an XML tag describing the given data-type. Most data-types produce a {@code } tag,
+ * fully describing the data-type. Where possible a {@code } tag is produced, which just gives
* the name of the data-type, deferring a full description of the data-type. For certain simple or
- * nameless data-types, a tag is emitted giving a full description.
+ * nameless data-types, a {@code } tag is emitted giving a full description.
* @param type is the data-type to be converted
* @param size is the size in bytes of the specific instance of the data-type
* @return a StringBuilder containing the XML tag
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/reloc/Relocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/reloc/Relocation.java
index f3f7454c9d..fa8a40323c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/reloc/Relocation.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/reloc/Relocation.java
@@ -83,9 +83,9 @@ public class Relocation {
}
/**
- * The name of the symbol being relocated or null if there is no symbol name.
+ * The name of the symbol being relocated or null if there is no symbol name.
*
- * @return the name of the symbol being relocated or null if there is no symbol name.
+ * @return the name of the symbol being relocated or null if there is no symbol name.
*/
public String getSymbolName() {
return symbolName;
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/Scalar.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/Scalar.java
index db9e757983..c2b32fd371 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/Scalar.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/scalar/Scalar.java
@@ -214,8 +214,8 @@ public class Scalar implements Comparable {
}
/**
- * Adds the integer n to this.
- * Computes (this = this + n).
+ * Adds the integer n to this.
+ * Computes (this = this + n).
* @param n the value to add to this scalars value to produce a new scalar.
*/
public Scalar add(long n) {
@@ -279,7 +279,7 @@ public class Scalar implements Comparable {
}
/**
- * Sets this = this << n.
+ * Sets this = this << n.
* @param n the number of bits to shift left.
* @throws ArithmeticException if n < 0.
*/
@@ -291,7 +291,7 @@ public class Scalar implements Comparable {
}
/**
- * Sets this = this >> n using 0 as the fill bit.
+ * Sets this = this >> n using 0 as the fill bit.
* @param n the number of bits to shift right.
* @throws ArithmeticException if n < 0.
*/
@@ -303,7 +303,7 @@ public class Scalar implements Comparable {
}
/**
- * Sets this = this >> n replicating the sign bit.
+ * Sets this = this >> n replicating the sign bit.
* @param n the number of bits to arithmetically shift.
* @throws ArithmeticException if n < 0.
*/
@@ -315,7 +315,7 @@ public class Scalar implements Comparable {
}
/**
- * Sets this = this - n.
+ * Sets this = this - n.
* @param n the value to subtract from this scalar to produce a new scalar.
*/
public Scalar subtract(long n) {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/Symbol.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/Symbol.java
index 7dbdf917bd..2a49b9c8fd 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/Symbol.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/Symbol.java
@@ -113,7 +113,7 @@ public interface Symbol {
/**
* Returns all memory references to the address of this symbol. If you do not have a
* {@link TaskMonitor} instance, then you can pass {@link TaskMonitorAdapter#DUMMY_MONITOR} or
- * null.
+ * null.
*
* @return all memory references to the address of this symbol.
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/SymbolUtilities.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/SymbolUtilities.java
index b26c7d681e..e610d7a58a 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/SymbolUtilities.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/symbol/SymbolUtilities.java
@@ -1021,7 +1021,7 @@ public class SymbolUtilities {
/**
* Returns a comparator for symbols. The comparison is based upon the name. This call
- * replaces the former compareTo method on Symbol. This comparator returned here
+ * replaces the former compareTo method on Symbol. This comparator returned here
* is case-insensitive.
*
* @return the comparator
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/PlateFieldLocation.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/PlateFieldLocation.java
index f10a3f23a9..c3ebe11370 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/PlateFieldLocation.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/PlateFieldLocation.java
@@ -43,7 +43,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
* @param charOffset the character position on the row of the location.
* @param comment plate comment text
* @param commentRow The row index into the comments of this location. This is different
- * than the row due to the fact that the PlateField has fictitious borders
+ * than the row due to the fact that the PlateField has fictitious borders
* that don't exist in the actual comment.
*/
public PlateFieldLocation(Program program, Address addr, int[] componentPath, int row,
@@ -76,7 +76,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
/**
* Returns the index into the String[] returned by {@link #getComment()} that represents
- * the comment row that was clicked. -1 will be returned if the border of the
+ * the comment row that was clicked. -1 will be returned if the border of the
* plate field was clicked.
*
* Note: This value is different than that returned by {@link #getRow()}, as that
@@ -84,7 +84,7 @@ public class PlateFieldLocation extends CommentFieldLocation {
* decoration to the comments, which causes the screen row to differ from the comment
* row.
* @return the index into the String[] returned by {@link #getComment()} that represents
- * the comment row that was clicked. -1 will be returned if the border of the
+ * the comment row that was clicked. -1 will be returned if the border of the
* plate field was clicked.
*/
public int getCommentRow() {
diff --git a/Ghidra/Framework/Utility/src/main/java/generic/jar/ResourceFile.java b/Ghidra/Framework/Utility/src/main/java/generic/jar/ResourceFile.java
index 61fcdeb9a1..1b8f3059e7 100644
--- a/Ghidra/Framework/Utility/src/main/java/generic/jar/ResourceFile.java
+++ b/Ghidra/Framework/Utility/src/main/java/generic/jar/ResourceFile.java
@@ -225,7 +225,7 @@ public class ResourceFile implements Comparable {
* Returns a File object. If this ResourceFile represents a standard filesystem, then no
* copy is necessary to return a file. If this ResourceFile represents a compressed
* filesystem, then a copy from that filesystem to the real filesystem is needed to create
- * a File object. copyIfNeeded allows you to dictate whether a copy should take
+ * a File object. copyIfNeeded allows you to dictate whether a copy should take
* place, if needed.
*
* If you just want the contents of a file, then call {@link #getInputStream()}.
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/util/MonitoredOutputStream.java b/Ghidra/Framework/Utility/src/main/java/ghidra/util/MonitoredOutputStream.java
index fdaf7f5800..eaad5e9410 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/MonitoredOutputStream.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/MonitoredOutputStream.java
@@ -52,9 +52,9 @@ public class MonitoredOutputStream extends OutputStream {
*
* The write method of FilterOutputStream
* calls the write method of its underlying output stream,
- * that is, it performs out.write(b).
+ * that is, it performs out.write(b).
*
- * Implements the abstract write method of OutputStream.
+ * Implements the abstract write method of OutputStream.
*
* @param b the byte.
* @exception IOException if an I/O error occurs.
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/util/Msg.java b/Ghidra/Framework/Utility/src/main/java/ghidra/util/Msg.java
index 9b92850c4a..5f4eb0c2b7 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/Msg.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/Msg.java
@@ -22,7 +22,7 @@ import java.awt.Component;
* more detailed message (e.g., stacktrace).
*
* The 'message' parameter for these calls is typically a String. However, it can also
- * be a log4j Message object as well. (See log4j2 for details.)
+ * be a log4j Message object as well. (See log4j2 for details.)
*/
public class Msg {
private static ErrorLogger errorLogger = new DefaultErrorLogger();
diff --git a/Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java b/Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java
index 09b05f67ed..3eae621cd7 100644
--- a/Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java
+++ b/Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java
@@ -152,7 +152,7 @@ public class SystemUtilities {
/**
* Checks to see if the font size override setting is enabled and adjusts
* the given font as necessary to match the override setting. If the setting
- * is not enabled, then font is returned.
+ * is not enabled, then font is returned.
*
* @param font
* The current font to adjust, if necessary.
@@ -408,7 +408,7 @@ public class SystemUtilities {
* This method is useful to print values of code that you cannot edit while debugging.
*
* Example, inside of your conditional breakpoint for a method on a Sun Java file you
- * can put something like: printString("Value of first arg: " + arg0, System.err)
+ * can put something like: printString("Value of first arg: " + arg0, System.err)
*
* Note: Don't remove this method simply because no code is referencing it, as it is used
* by conditional breakpoints.
diff --git a/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java b/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java
index 0d843a2176..f66b34ad46 100644
--- a/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java
+++ b/Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java
@@ -493,8 +493,8 @@ public final class FileUtilities {
}
/**
- * Copies the contents of originalDir to copyDir. If the originalDir
- * does not exist, then this method will do nothing. If copyDir does not exist, then
+ * Copies the contents of originalDir to copyDir. If the originalDir
+ * does not exist, then this method will do nothing. If copyDir does not exist, then
* it will be created as necessary.
*
* @param originalDir The directory from which to extract contents
@@ -635,7 +635,7 @@ public final class FileUtilities {
}
/**
- * Copy the in stream to the out stream. The output stream will
+ * Copy the in stream to the out stream. The output stream will
* not be closed when the copy operation is finished.
*
* @param in source input stream
@@ -843,7 +843,7 @@ public final class FileUtilities {
/**
* Returns true if the given file:
*
- * - is null, or
+ * - is
null, or
* - {@link File#isFile()} is true,
* - and {@link File#length()} is == 0.
*
@@ -890,7 +890,7 @@ public final class FileUtilities {
* the paths are the same or unrelated, then null is returned.
*
* For example, given, in this order, two files with these paths
- * /a/b and /a/b/c, this method will return 'c'.
+ * /a/b and /a/b/c, this method will return 'c'.
*
* @param f1 the parent file
* @param f2 the child file
diff --git a/Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java b/Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java
index 8cac1b2d38..022b87d659 100644
--- a/Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java
+++ b/Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java
@@ -42,9 +42,9 @@ public class ReflectionUtilities {
}
/**
- * Locates the field of the name fieldName on the given
+ * Locates the field of the name fieldName on the given
* class. If the given class does not contain the field, then this
- * method will recursively call up containingClass's
+ * method will recursively call up containingClass's
* implementation tree looking for a parent implementation of the
* requested field.
*
@@ -73,9 +73,9 @@ public class ReflectionUtilities {
}
/**
- * Locates the field of the name fieldName on the given
+ * Locates the field of the name fieldName on the given
* class. If the given class does not contain the field, then this
- * method will recursively call up containingClass's
+ * method will recursively call up containingClass's
* implementation tree looking for a parent implementation of the
* requested field.
*
@@ -104,9 +104,9 @@ public class ReflectionUtilities {
}
/**
- * Locates the method of the name methodName on the given
+ * Locates the method of the name methodName on the given
* class. If the given class does not contain the method, then this
- * method will recursively call up containingClass's
+ * method will recursively call up containingClass's
* implementation tree looking for a parent implementation of the
* requested method.
*
@@ -294,9 +294,9 @@ public class ReflectionUtilities {
}
/**
- * Uses the given patterns to remove elements from the given stack trace.
- * The current implementation will simply perform a toString() on each element and
- * then check to see if that string contains any of the patterns.
+ * Uses the given patterns to remove elements from the given stack trace.
+ * The current implementation will simply perform a toString() on each element and
+ * then check to see if that string contains any of the patterns.
*
* @param trace the trace to filter
* @param patterns the non-regex patterns used to perform a
@@ -423,7 +423,7 @@ public class ReflectionUtilities {
* classes. Further, interface hierarchies are examined before concrete parent extensions.
*
* If the given items have no parents in common, then the result will be a list with
- * only Object.class.
+ * only Object.class.
*
* @param list the items to examine
* @return the set of items
@@ -466,7 +466,7 @@ public class ReflectionUtilities {
* classes. Further, interface hierarchies are examined before concrete parent extensions.
*
* If the given items have no parents in common, then the result will be a list with
- * only Object.class.
+ * only Object.class.
*
* @param list the items to examine
* @return the set of items
@@ -526,7 +526,7 @@ public class ReflectionUtilities {
* Returns an order set of all interfaces implemented and classes extended for the entire
* type structure of the given class.
*
- * If Object.class is passed to this method, then it will be returned in the
+ * If Object.class is passed to this method, then it will be returned in the
* result of this method.
*
* @param c the class to introspect
diff --git a/Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java b/Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java
index bf1ac4bbd7..50dc664064 100644
--- a/Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java
+++ b/Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java
@@ -23,7 +23,7 @@ package utility.function;
public interface Callback {
/**
- * Creates a dummy callback function. This is useful to avoid using null.
+ * Creates a dummy callback function. This is useful to avoid using null.
* @return a dummy callback function
*/
public static Callback dummy() {
@@ -33,10 +33,10 @@ public interface Callback {
}
/**
- * Returns the given callback object if it is not null. Otherwise, a {@link #dummy()}
- * callback is returned. This is useful to avoid using null.
+ * Returns the given callback object if it is not null. Otherwise, a {@link #dummy()}
+ * callback is returned. This is useful to avoid using null.
*
- * @param c the callback function to check for null
+ * @param c the callback function to check for null
* @return a non-null callback function
*/
public static Callback dummyIfNull(Callback c) {
diff --git a/Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java b/Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java
index 812a3dbcc7..e340102298 100644
--- a/Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java
+++ b/Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java
@@ -206,18 +206,18 @@ public class ModuleUtilities {
/**
* Returns true if the given path is parented by a module root directory.
*
- * For example, given a module path of /some/dir/features/cool_module/, then this
+ * For example, given a module path of /some/dir/features/cool_module/, then this
* method will return true for these paths:
*
*
- * /some/dir/features/cool_module
- * /some/dir/features/cool_module/some/child/dir
+ * /some/dir/features/cool_module
+ * /some/dir/features/cool_module/some/child/dir
*
*
and false for these paths:
*
*
- * /some/random/path
- * /some/dir/features/
+ * /some/random/path
+ * /some/dir/features/
*
* @param pathName the path name to check
* @return true if the given path is parented by a module root directory.
@@ -231,18 +231,18 @@ public class ModuleUtilities {
* Returns the path of the module containing the given path string, if it is parented by a
* module root directory.
*
- * For example, given a module path of /some/dir/features/cool_module/, then this
+ * For example, given a module path of /some/dir/features/cool_module/, then this
* method will return that module path, given these paths:
*
*
- * /some/dir/features/cool_module
- * /some/dir/features/cool_module/some/child/dir
+ * /some/dir/features/cool_module
+ * /some/dir/features/cool_module/some/child/dir
*
*
and null for these paths:
*
*
- * /some/random/path
- * /some/dir/features/
+ * /some/random/path
+ * /some/dir/features/
*
* @param pathName the path name to check
* @return the module root directory; null if the path is not in a module
@@ -274,13 +274,13 @@ public class ModuleUtilities {
* here means a folder that contains a repository folder. As an example, given a repo
* structure of:
*
- * /userdir/repoRoot/repoDir/.git
+ * /userdir/repoRoot/repoDir/.git
*
*
then this method, given will produce the following results (input -> output):
*
- * /userdir/repoRoot/repoDir/.git -> /userdir/repoRoot
- *
/userdir/repoRoot/repoDir -> /userdir/repoRoot
- *
/userdir/repoRoot -> /userdir/repoRoot
+ * /userdir/repoRoot/repoDir/.git -> /userdir/repoRoot
+ *
/userdir/repoRoot/repoDir -> /userdir/repoRoot
+ *
/userdir/repoRoot -> /userdir/repoRoot
*
*
* @param f the child file of the desired repo
@@ -314,12 +314,12 @@ public class ModuleUtilities {
* Returns a file that is the repository folder containing the given file. As an example,
* given a repo structure of:
*
- *
/userdir/repoRoot/repoDir/.git
+ * /userdir/repoRoot/repoDir/.git
*
*
then this method, given will produce the following results (input -> output):
*
- * /userdir/repoRoot/repoDir/.git -> /userdir/repoRoot/repoDir
- *
/userdir/repoRoot/repoDir -> /userdir/repoRoot/repoDir
+ * /userdir/repoRoot/repoDir/.git -> /userdir/repoRoot/repoDir
+ *
/userdir/repoRoot/repoDir -> /userdir/repoRoot/repoDir
*
* @param f the child file of the desired repo
* @return a file that is the repo folder of the repository containing the given file; null
diff --git a/gradle/root/distribution.gradle b/gradle/root/distribution.gradle
index d13c9f0f71..6ef5fa56c5 100644
--- a/gradle/root/distribution.gradle
+++ b/gradle/root/distribution.gradle
@@ -60,6 +60,9 @@ task createJavadocs(type: Javadoc, description: 'Generate javadocs for all proje
options.addBooleanOption("-no-module-directories", true)
}
+ // generate documentation using html5
+ options.addBooleanOption("html5", true)
+
// Some internal packages are not public and need to be exported.
options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED",
"java.desktop/sun.awt=ALL-UNNAMED",
| |