map = librarySymbolsMap.get(library);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/LoaderInfoHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/LoaderInfoHeader.java
index 43a8f1c921..f2553cd343 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/LoaderInfoHeader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/LoaderInfoHeader.java
@@ -25,7 +25,7 @@ import java.util.List;
/**
* See Apple's -- PEFBinaryFormat.h
- *
+ * {@literal
* struct PEFLoaderInfoHeader {
* SInt32 mainSection; // Section containing the main symbol, -1 => none.
* UInt32 mainOffset; // Offset of main symbol.
@@ -42,7 +42,7 @@ import java.util.List;
* UInt32 exportHashTablePower; // Export hash table size as log 2. (Log2('h'))
* UInt32 exportedSymbolCount; // Number of exported symbols. ('e')
* };
- *
+ * }
*/
public class LoaderInfoHeader implements StructConverter {
public final static int SIZEOF = 56;
@@ -258,7 +258,6 @@ public class LoaderInfoHeader implements StructConverter {
/**
* Finds the PEF library that contains the specified imported symbol index.
- * @param loader the PEF loader info header
* @param symbolIndex the imported symbol index
* @return PEF library that contains the specified imported symbol index
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/RelocationState.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/RelocationState.java
index c30920a0c1..769bf4a03c 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/RelocationState.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/RelocationState.java
@@ -66,7 +66,7 @@ public class RelocationState {
* @param header the PEF container header
* @param relocationHeader the specific relocation header for this state
* @param program the program being relocated
- * @param sectionMap the map of section headers to memory blocks
+ * @param importState the current import state
*/
public RelocationState(ContainerHeader header, LoaderRelocationHeader relocationHeader,
Program program, ImportStateCache importState) {
@@ -191,7 +191,6 @@ public class RelocationState {
/**
* Increments the integer in memory at the specified address
- * @param program the program
* @param address the address to increment
* @param addend the value to add
* @param log a message log
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionHeader.java
index c3865e96ac..18df9d529d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionHeader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionHeader.java
@@ -28,7 +28,7 @@ import java.io.InputStream;
* See Apple's -- PEFBinaryFormat
*
* struct PEFSectionHeader {
- * SInt32 nameOffset; // Offset of name within the section name table, -1 => none.
+ * SInt32 nameOffset; // Offset of name within the section name table, -1 => none.
* UInt32 defaultAddress; // Default address, affects relocations.
* UInt32 totalLength; // Fully expanded size in bytes of the section contents.
* UInt32 unpackedLength; // Size in bytes of the "initialized" part of the contents.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionKind.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionKind.java
index 9da61a2816..3b65f30018 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionKind.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pef/SectionKind.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,7 +20,7 @@ package ghidra.app.util.bin.format.pef;
* Section kind values for instantiated sections.
*/
public enum SectionKind {
- /** Code, presumed pure & position independent.*/
+ /** Code, presumed pure and position independent.*/
Code(0, true),
/** Unpacked writeable data.*/
UnpackedData(1, true),
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/xcoff/XCoffFileHeaderFlags.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/xcoff/XCoffFileHeaderFlags.java
index 07ef584b0b..c878d1dd45 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/xcoff/XCoffFileHeaderFlags.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/xcoff/XCoffFileHeaderFlags.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -38,7 +37,7 @@ public final class XCoffFileHeaderFlags {
public final static int F_AR32WR = 0x0100;
/** file is 32-bit big-endian */
public final static int F_AR32W = 0x0200;
- /** rs/6000 aix: dynamically loadable w/imports & exports */
+ /** rs/6000 aix: dynamically loadable w/imports and exports */
public final static int F_DYNLOAD = 0x1000;
/** rs/6000 aix: file is a shared object */
public final static int F_SHROBJ = 0x2000;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
index d84fa9bdff..70ab14a32f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/cparser/CPP/DefineTable.java
@@ -63,9 +63,9 @@ public class DefineTable {
}
/**
- * @param image
- * @param pos
- * @return
+ * @param buf the buffer containing the define
+ * @param pos the position of the define
+ * @return the define
*/
public String getDefineAt(StringBuffer buf, int pos) {
Hashtable findTable = lookupTable;
@@ -540,9 +540,10 @@ public class DefineTable {
}
/**
- * @param image
- * @param i
- * @return
+ * @param buf the buffer containing the parameters
+ * @param start the starting index of the parameters in the buffer
+ * @param endChar the delimiter for the parameters
+ * @return the parameters
*/
public String getParams(StringBuffer buf, int start, char endChar) {
int len = buf.length();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeSelectionDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeSelectionDialog.java
index fe9cda837e..add87eb097 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeSelectionDialog.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeSelectionDialog.java
@@ -171,8 +171,6 @@ public class DataTypeSelectionDialog extends DialogComponentProvider {
* This method is useful for widgets that have embedded editors that launch this dialog. For
* these editors, like tables, it is nice to be able to tab through various editors. This
* method allows these editors to keep this functionality, even though a new dialog was shown.
- *
- * @see #wasClosedByTab
*/
public void setTabCommitsEdit(boolean doesCommit) {
editor.setTabCommitsEdit(doesCommit);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeUrl.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeUrl.java
index 0c46d1af1c..f5adc25086 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeUrl.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/DataTypeUrl.java
@@ -25,9 +25,9 @@ import ghidra.util.UniversalID;
/**
* A class to produce and parse URLs of the form:
- *
+ * {@literal
* datatype:/12345678?uid=12345678&name=Bob
- *
+ * }
* where the first number is the ID of the {@link DataTypeManager} and the second number is
* the {@link DataType} ID.
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/DataApplyOptions.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/DataApplyOptions.java
index ae873737f1..f4a0ac2328 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/DataApplyOptions.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/DataApplyOptions.java
@@ -136,7 +136,7 @@ public class DataApplyOptions {
/**
* Sets whether or not to disassemble and create a function that is referred to
* by the current new structure.
- * @param createLabel true indicates a function should be created.
+ * @param createFunction true indicates a function should be created.
*/
public void setCreateFunction(boolean createFunction) {
this.createFunction = createFunction;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GuidDataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GuidDataType.java
index 1d1f49fc77..b76cf818f4 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GuidDataType.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GuidDataType.java
@@ -66,65 +66,41 @@ public class GuidDataType extends BuiltIn {
super(null, NAME, dtm);
}
- /**
- *
- * @see ghidra.program.model.data.DataType#getMnemonic(Settings)
- */
+ @Override
public String getMnemonic(Settings settings) {
return NAME;
}
- /**
- *
- * @see ghidra.program.model.data.DataType#getLength()
- */
+ @Override
public int getLength() {
return SIZE;
}
- /**
- * @see ghidra.program.model.data.DataType#isDynamicallySized()
- */
+ @Override
public boolean isDynamicallySized() {
return false;
}
- /**
- *
- * @see ghidra.program.model.data.DataType#getDescription()
- */
+ @Override
public String getDescription() {
return NAME;
}
- /**
- *
- * @see ghidra.program.model.data.DataType#getValue(ghidra.program.model.mem.MemBuffer, ghidra.docking.settings.Settings, int)
- */
+ @Override
public Object getValue(MemBuffer buf, Settings settings, int length) {
return getString(buf, settings);
}
- /**
- *
- * @see ghidra.program.model.data.DataType#getRepresentation(MemBuffer, Settings, int)
- */
+ @Override
public String getRepresentation(MemBuffer buf, Settings settings, int length) {
return getString(buf, settings);
}
- /**
- * @see ghidra.program.model.data.BuiltIn#getBuiltInSettingsDefinitions()
- */
@Override
protected SettingsDefinition[] getBuiltInSettingsDefinitions() {
return SETTINGS_DEFS;
}
- /**
- *
- * @see ghidra.program.model.data.ByteDataType#getString(ProcessorContext, Settings)
- */
protected String getString(MemBuffer buf, Settings settings) {
Object guidName = settings.getValue(KEY);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java
index 3e2d7ebbd6..23b498a8e0 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTI0DataType.java
@@ -346,7 +346,7 @@ public class RTTI0DataType extends RTTIDataType {
* Gets the total length of the data created when this data type is placed at the indicated
* address in memory.
* @param memory the program memory for this data.
- * @param address the start address of the data.
+ * @param startAddress the start address of the data.
* @return the length of the data. zero is returned if valid data can't be created at the
* indicated address using this data type.
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTIDataType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTIDataType.java
index 903c4024c6..dbeb697bed 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTIDataType.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/RTTIDataType.java
@@ -37,7 +37,7 @@ public abstract class RTTIDataType extends DynamicDataType {
/**
* Determines if the data type is valid for placing at the indicated address in the program.
* @param program the program
- * @param address the address
+ * @param startAddress the start address
* @param overwriteInstructions true indicates that existing instructions can be overwritten
* by this data type.
* @param overwriteDefinedData true indicates that existing defined data can be overwritten
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/CharacterIterator.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/CharacterIterator.java
index 6c3bddaccb..362363c098 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/CharacterIterator.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/CharacterIterator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -74,8 +73,6 @@ public class CharacterIterator {
/**
* Sets the position to the specified position in the text.
* @param index the position within the text.
- * @return the character at the specified position
- * @throws IllegalArgumentException if index is not in range from 0 to string.length()-1
*/
public void setIndex(int index) {
if (index < 0 || index > string.length() - 1) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunctionIndirect.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunctionIndirect.java
index ef0eef5849..140a79da35 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunctionIndirect.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunctionIndirect.java
@@ -23,7 +23,7 @@ import ghidra.program.model.data.*;
/**
* A class to represent a demangled function indirect. A function indirect is
* similar to a function pointer or a function reference except that it does
- * not have the start (*) for a pointer or ampersand (&) for a reference, but
+ * not have the start (*) for a pointer or ampersand (&) for a reference, but
* is still an indirect definition (not a regular function definition). The
* function indirect is prevalent in the Microsoft model, if not other models.
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledObject.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledObject.java
index c353a8b070..aae834ea12 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledObject.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledObject.java
@@ -298,11 +298,11 @@ public abstract class DemangledObject {
/**
* Returns a complete signature for the demangled symbol.
- * For example:
+ *
For example:
* "unsigned long foo"
* "unsigned char * ClassA::getFoo(float, short *)"
- * "void * getBar(int **, MyStruct &)"
- * Note: based on the underlying mangling scheme, the
+ * "void * getBar(int **, MyStruct &)"
+ *
Note: based on the underlying mangling scheme, the
* return type may or may not be specified in the signature.
* @param format true if signature should be pretty printed
* @return a complete signature for the demangled symbol
@@ -463,11 +463,12 @@ public abstract class DemangledObject {
return list;
}
+ // TODO needs updating. Couldn't determine what getResigualNamespacePath was changed to.
/**
* Get or create the specified typeNamespace. The returned namespace may only be a partial
* namespace if errors occurred. The caller should check the returned namespace and adjust
* any symbol creation accordingly. Caller should use
- * {@link #getResidualNamespacePath(DemangledType, Namespace)} to handle the case where
+ * getResidualNamespacePath(DemangledType, Namespace) to handle the case where
* only a partial namespace has been returned.
* @param program
* @param typeNamespace demangled namespace
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledType.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledType.java
index 4a8c14ce40..389eb05262 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledType.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledType.java
@@ -36,7 +36,7 @@ public class DemangledType {
* (such as Foo::Bar) and breaks it into a hierarchy of types where each type
* represents one item in the list of namespace elements.
*
- * @param demangledType the type to split
+ * @param otherNamespace the type to convert
* @return the original type if the name does not represent a namespace; a new type
* that contains a child, that contains a child and so on, representing the
* split-up of the original namespace string.
@@ -129,8 +129,8 @@ public class DemangledType {
}
/**
- * Sets the original mangled name
- * @param mangled the original mangled name
+ * Gets the original mangled name
+ * @return the original mangled name
*/
public String getOriginalMangled() {
return originalMangled;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerOptions.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerOptions.java
index 3e98821655..42d607e6d9 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerOptions.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerOptions.java
@@ -35,62 +35,58 @@ public class DemanglerOptions {
}
/**
- * True signals to apply function signatures that are demangled.
+ * Checks if the apply signature option is currently set.
*
- * @param doSignature True signals to apply function signatures that are demangled.
+ * @return true if set to apply function signatures that are demangled.
*/
public boolean applySignature() {
return applySignature;
}
/**
- * True signals to apply function signatures that are demangled.
+ * Set the option to apply function signatures that are demangled.
*
- * @param doSignature True signals to apply function signatures that are demangled.
+ * @param applySignature true to apply function signatures that are demangled.
*/
public void setApplySignature(boolean applySignature) {
this.applySignature = applySignature;
}
/**
- * True signals to perform disassembly for known data structures (like functions) when
- * demangling.
+ * Checks if the option to perform disassembly for known data structures (like functions) when
+ * demangling is set.
*
- * @param doSignature True signals to perform disassembly
+ * @return true if the option is set.
*/
public boolean doDisassembly() {
return doDisassembly;
}
/**
- * True signals to perform disassembly for known data structures (like functions) when
+ * Sets the option to perform disassembly for known data structures (like functions) when
* demangling.
*
- * @param doSignature True signals to perform disassembly
+ * @param doDisassembly true to perform disassembly when demangling.
*/
public void setDoDisassembly(boolean doDisassembly) {
this.doDisassembly = doDisassembly;
}
/**
- * True signals to only demangle symbol names that follow known mangled patterns. False triggers
- * all symbols to be demangled, which results in some symbols getting demangled that were not
- * actually mangled symbols.
+ * Checks if the option to only demangle known mangled patterns is set.
*
- * @param demangleOnlyKnownPatterns True signals to only demangle symbol names that follow
- * known mangled patterns.
+ * @return true if only known mangled patterns will be demangled.
*/
public boolean demangleOnlyKnownPatterns() {
return demangleOnlyKnownPatterns;
}
/**
- * True signals to only demangle symbol names that follow known mangled patterns. False triggers
- * all symbols to be demangled, which results in some symbols getting demangled that were not
+ * Sets the option to only demangle known mangled patterns. Setting this to false causes
+ * all symbols to be demangled, which may result in some symbols getting demangled that were not
* actually mangled symbols.
*
- * @param demangleOnlyKnownPatterns True signals to only demangle symbol names that follow
- * known mangled patterns.
+ * @param demangleOnlyKnownPatterns true to only demangle known mangled patterns.
*/
public void setDemangleOnlyKnownPatterns(boolean demangleOnlyKnownPatterns) {
this.demangleOnlyKnownPatterns = demangleOnlyKnownPatterns;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerUtil.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerUtil.java
index 3eb1ff0dce..3b85f0e534 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerUtil.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemanglerUtil.java
@@ -98,7 +98,7 @@ public class DemanglerUtil {
/**
* Converts the list of names into a namespace linked list.
* Given names = { "A", "B", "C" }, which represents "A::B::C".
- * The following will be created "Namespace{A}->Namespace{B}->Namespace{C}"
+ * The following will be created {@literal "Namespace{A}->Namespace{B}->Namespace{C}"}
* and Namespace{C} will be returned.
*
* NOTE: the list will be empty after the call.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java
index 5004960bc3..655e1fad1b 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/dialog/CheckoutDialog.java
@@ -43,10 +43,6 @@ public class CheckoutDialog extends DialogComponentProvider {
private boolean exclusiveCheckout;
private int actionID = DO_NOT_CHECKOUT;
- /**
- * Constructor
- * @param fileList list of DomainFile objects that are checked out
- */
public CheckoutDialog(DomainFile df, User user) {
super("Versioned File not Checked Out", true);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Exporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Exporter.java
index 1588138f50..47e9ede3a2 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Exporter.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Exporter.java
@@ -104,7 +104,7 @@ abstract public class Exporter implements ExtensionPoint {
* Returns true if this exporter knows how to export the given domain object. For example,
* some exporters know how to export programs, other exporters can export project data type
* archives.
- * @param domainObject the domain object to test for exporting.
+ * @param domainObjectClass the class of the domain object to test for exporting.
* @return true if this exporter knows how to export the given domain object.
*/
public boolean canExportDomainObject(Class domainObjectClass) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessAnalyzer.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessAnalyzer.java
index 2f123b9a54..e47e7fcb6a 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessAnalyzer.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/headless/HeadlessAnalyzer.java
@@ -956,7 +956,7 @@ public class HeadlessAnalyzer {
}
/**
- * Run prescripts -> analysis -> postscripts (any of these steps is optional).
+ *{@literal Run prescripts -> analysis -> postscripts (any of these steps is optional).}
* @param fileAbsolutePath Path of the file to analyze.
* @param program The program to analyze.
* @return true if the program file should be kept. If analysis or scripts have marked
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/importer/LibrarySearchPathManager.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/importer/LibrarySearchPathManager.java
index 1423dc13f9..df6c0cae8c 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/importer/LibrarySearchPathManager.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/importer/LibrarySearchPathManager.java
@@ -89,7 +89,7 @@ public class LibrarySearchPathManager {
* Call this to restore paths that were previously persisted. If you really need to change
* the paths for the entire JVM, then call {@link #setLibraryPaths(String[])}.
*
- * @param the paths to restore
+ * @param paths the paths to restore
*/
public static void restoreLibraryPaths(String[] paths) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java
index 7d22e19791..4e9b49c389 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractProgramLoader.java
@@ -204,7 +204,7 @@ public abstract class AbstractProgramLoader implements Loader {
}
/**
- * This gets called after the given list of {@Program}s is finished loading. It provides
+ * This gets called after the given list of {@link Program}s is finished loading. It provides
* subclasses an opportunity to do follow-on actions to the load.
*
* @param loadedPrograms The {@link Program}s that got loaded.
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 9af4bceee3..eda277e84b 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
@@ -49,7 +49,7 @@ public class BoundedBufferedReader extends Reader {
* Input-buffer size
*
* @exception IllegalArgumentException
- * If sz is <= 0
+ * If sz is <= 0
*/
public BoundedBufferedReader(Reader in, int sz) {
super(in);
@@ -458,7 +458,7 @@ public class BoundedBufferedReader extends Reader {
* than limit. Therefore large values should be used with care.
*
* @exception IllegalArgumentException
- * If readAheadLimit is < 0
+ * If readAheadLimit is < 0
* @exception IOException
* If an I/O error occurs
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/MemorySectionResolver.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/MemorySectionResolver.java
index a991160e09..b030036e87 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/MemorySectionResolver.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/MemorySectionResolver.java
@@ -53,7 +53,7 @@ public abstract class MemorySectionResolver {
* @param key the loadable section key which corresponds to this memory "section"
* @param fileOffset data source file offset. It is assumed that all initialized
* "sections" draw from a single data source.
- * @param length number of bytes within "section"
+ * @param numberOfBytes number of bytes within "section"
* @param startAddress desired physical start address of "section"
* @param sectionName name of "section"
* @param isReadable true if "section" has read privilege
@@ -90,7 +90,7 @@ public abstract class MemorySectionResolver {
* Add uninitialized memory "section".
* The last "section" defined will take precedence when resolving conflicts.
* @param key the loadable section key which corresponds to this memory "section"
- * @param length number of bytes within "section"
+ * @param numberOfBytes number of bytes within "section"
* @param startAddress desired physical start address of "section"
* @param sectionName name of "section"
* @param isReadable true if "section" has read privilege
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/parser/FunctionSignatureParser.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/parser/FunctionSignatureParser.java
index 28839c9972..4b6d26c670 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/parser/FunctionSignatureParser.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/parser/FunctionSignatureParser.java
@@ -44,7 +44,7 @@ import ghidra.util.exception.CancelledException;
*
* Some examples of valid c++ that would fail due to the current limitations:
*
- * void foo(myclass x) - fails due to comma in x's data type name
+ * {@literal void foo(myclass x) - fails due to comma in x's data type name}
* int operator()(int x) - fails due to parens in function name unsigned int
* bar(float y) - fails due to space in return type name
*
@@ -345,8 +345,8 @@ public class FunctionSignatureParser {
}
/**
- *
+ * Implementation intended for use with {@link FunctionSignatureParser}
* and underlying {@link DataTypeParser} and {@link DataTypeUtilities} classes.
*/
private static class ParserDataTypeManagerService implements DataTypeQueryService {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/recognizer/Recognizer.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/recognizer/Recognizer.java
index 8484da014d..6bdd6d03d2 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/recognizer/Recognizer.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/recognizer/Recognizer.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,8 +39,7 @@ public interface Recognizer extends ExtensionPoint {
* efficiency's sake the array of bytes is just passed to each recognizer in
* turn. Abuse this and we will need to create copies, and everyone loses.
*
- * @param byteProvider
- * the byte provider
+ * @param bytes the bytes to recognize
* @return a String description of the recognition, or null if it is not
* recognized
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AddressAnnotatedStringHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AddressAnnotatedStringHandler.java
index ae7b6f544d..94bb1e3110 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AddressAnnotatedStringHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AddressAnnotatedStringHandler.java
@@ -36,9 +36,6 @@ public class AddressAnnotatedStringHandler implements AnnotatedStringHandler {
+ "string";
private static final String[] SUPPORTED_ANNOTATIONS = { "address", "addr" };
- /**
- * @see AnnotatedStringHandler#createAnnotatedString(AttributedString, String[], ServiceProvider)
- */
@Override
public AttributedString createAnnotatedString(AttributedString prototypeString, String[] text,
Program program) throws AnnotationException {
@@ -81,18 +78,12 @@ public class AddressAnnotatedStringHandler implements AnnotatedStringHandler {
return new AttributedString(buffer.toString(), Color.LIGHT_GRAY,
prototypeString.getFontMetrics(0));
}
-
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getSupportedAnnotations()
- */
@Override
public String[] getSupportedAnnotations() {
return SUPPORTED_ANNOTATIONS;
}
- /**
- * @see AnnotatedStringHandler#handleMouseClick(String[], Navigatable, ServiceProvider)
- */
+ @Override
public boolean handleMouseClick(String[] annotationParts, Navigatable sourceNavigatable,
ServiceProvider serviceProvider) {
GoToService goToService = serviceProvider.getService(GoToService.class);
@@ -109,17 +100,11 @@ public class AddressAnnotatedStringHandler implements AnnotatedStringHandler {
return false;
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getDisplayString()
- */
@Override
public String getDisplayString() {
return "Address";
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getPrototypeString()
- */
@Override
public String getPrototypeString() {
return "{@address 0x00}";
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AnnotatedStringFieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AnnotatedStringFieldMouseHandler.java
index 52aedbaec5..678bf10f89 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AnnotatedStringFieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AnnotatedStringFieldMouseHandler.java
@@ -29,9 +29,6 @@ public class AnnotatedStringFieldMouseHandler implements FieldMouseHandlerExtens
private static final Class[] SUPPORTED_CLASSES =
new Class[] { AnnotatedTextFieldElement.class };
- /**
- * @see FieldMouseHandlerExtension#fieldElementClicked(Object, Navigatable, MouseEvent, ServiceProvider)
- */
@Override
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
ProgramLocation location, MouseEvent mouseEvent, ServiceProvider serviceProvider) {
@@ -42,9 +39,6 @@ public class AnnotatedStringFieldMouseHandler implements FieldMouseHandlerExtens
serviceProvider);
}
- /**
- * @see FieldMouseHandlerExtension#getSupportedProgramLocations()
- */
@Override
public Class[] getSupportedProgramLocations() {
return SUPPORTED_CLASSES;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/Annotation.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/Annotation.java
index ac79b39426..97efc7fdd0 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/Annotation.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/Annotation.java
@@ -67,9 +67,7 @@ public class Annotation {
/**
* Constructor
- * Note: This constructor assumes that the provided annotation text matches the
- * regular expression defined in {@link docking.widgets.fieldpanel.support.FieldUtils#ENCLOSING_ANNOTATION_PATTERN}, which
- * assures that the string starts with "{
@
" and ends with '}'
+ * Note: This constructor assumes that the string starts with "{@
" and ends with '}'
*
* @param annotationText The complete annotation text.
* @param prototypeString An AttributedString that provides the attributes for the display
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AssignedVariableFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AssignedVariableFieldFactory.java
index 8feadf9975..8463984fd7 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AssignedVariableFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/AssignedVariableFieldFactory.java
@@ -56,9 +56,6 @@ public class AssignedVariableFieldFactory extends FieldFactory {
super(FIELD_NAME, model, hsProvider, displayOptions, fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
@@ -119,9 +116,6 @@ public class AssignedVariableFieldFactory extends FieldFactory {
width, elements.length + 1, hlProvider);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int row, int col, ListingField bf) {
Object obj = bf.getProxy().getObject();
@@ -132,9 +126,6 @@ public class AssignedVariableFieldFactory extends FieldFactory {
return new AssignedVariableLocation(cu.getProgram(), cu.getMinAddress(), row, col);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation programLoc) {
@@ -146,9 +137,6 @@ public class AssignedVariableFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!CodeUnit.class.isAssignableFrom(proxyObjectClass)) {
@@ -164,9 +152,6 @@ public class AssignedVariableFieldFactory extends FieldFactory {
fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return DEFAULT_COLOR;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentFieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentFieldMouseHandler.java
index a836a0bee8..5e8d660f22 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentFieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentFieldMouseHandler.java
@@ -33,17 +33,11 @@ public class CommentFieldMouseHandler implements FieldMouseHandlerExtension {
new Class[] { CommentFieldLocation.class, EolCommentFieldLocation.class,
PlateFieldLocation.class, AutomaticCommentFieldLocation.class };
- /**
- * @see ghidra.app.util.viewer.field.FieldMouseHandlerExtension#getSupportedProgramLocations()
- */
@Override
public Class[] getSupportedProgramLocations() {
return SUPPORTED_CLASSES;
}
- /**
- * @see FieldMouseHandlerExtension#fieldElementClicked(Object, Navigatable, MouseEvent, ServiceProvider)
- */
@Override
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
ProgramLocation location, MouseEvent mouseEvent, ServiceProvider serviceProvider) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentUtils.java
index 96c546c819..4d5326675a 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentUtils.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/CommentUtils.java
@@ -101,7 +101,7 @@ public class CommentUtils {
/**
* Returns the display string for the given raw annotation text. Annotations are
- * encoded strings that fit this pattern: {@name text}. This method
+ * encoded strings that fit this pattern: {@literal {@name text}}. This method
* will parse the given text, converting any annotations into their display version.
*
* @param rawCommentText text that may include annotations
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ErrorFieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ErrorFieldMouseHandler.java
index 790615f93c..6712cfb74d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ErrorFieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ErrorFieldMouseHandler.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,9 +30,6 @@ public class ErrorFieldMouseHandler implements FieldMouseHandlerExtension {
private final static Class[] SUPPORTED_CLASSES = new Class[] { ErrorListingField.class };
- /**
- * @see ghidra.app.util.viewer.field.FieldMouseHandlerExtension#fieldElementClicked(java.lang.Object, Navigatable, java.awt.event.MouseEvent, ghidra.framework.plugintool.ServiceProvider)
- */
@Override
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
ProgramLocation location, MouseEvent mouseEvent, ServiceProvider serviceProvider) {
@@ -48,9 +44,6 @@ public class ErrorFieldMouseHandler implements FieldMouseHandlerExtension {
return true;
}
- /**
- * @see FieldMouseHandlerExtension#getSupportedProgramLocations()
- */
@Override
public Class[] getSupportedProgramLocations() {
return SUPPORTED_CLASSES;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionCallFixupFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionCallFixupFieldFactory.java
index 9b8c0b49ec..c79fb0b1a6 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionCallFixupFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionCallFixupFieldFactory.java
@@ -75,9 +75,6 @@ public class FunctionCallFixupFieldFactory extends FieldFactory {
OptionsGui.FUN_CALL_FIXUP.getDefaultColor());
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getField(ProxyObj, int)
- */
@Override
public ListingField getField(ProxyObj proxy, int varWidth) {
Object obj = proxy.getObject();
@@ -104,9 +101,6 @@ public class FunctionCallFixupFieldFactory extends FieldFactory {
new CompositeFieldElement(textElements), startX + varWidth, width, hlProvider);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int row, int col, ListingField bf) {
ProxyObj proxy = bf.getProxy();
@@ -121,9 +115,6 @@ public class FunctionCallFixupFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation loc) {
@@ -135,9 +126,6 @@ public class FunctionCallFixupFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!Function.class.isAssignableFrom(proxyObjectClass)) {
@@ -153,17 +141,11 @@ public class FunctionCallFixupFieldFactory extends FieldFactory {
fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return OptionsGui.FUN_CALL_FIXUP.getDefaultColor();
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureFieldFactory.java
index 3964806c5c..22ba668786 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureFieldFactory.java
@@ -113,9 +113,6 @@ public class FunctionSignatureFieldFactory extends FieldFactory {
literalColor = options.getColor(OptionsGui.SEPARATOR.getColorOptionName(), Color.BLACK);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getField(ProxyObj, int)
- */
@Override
public ListingField getField(ProxyObj proxy, int varWidth) {
Object obj = proxy.getObject();
@@ -282,9 +279,6 @@ public class FunctionSignatureFieldFactory extends FieldFactory {
return funNameColor;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int fieldRow, int fieldColumn,
ListingField listingField) {
@@ -315,9 +309,6 @@ public class FunctionSignatureFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation loc) {
@@ -412,9 +403,6 @@ public class FunctionSignatureFieldFactory extends FieldFactory {
return elements;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!Function.class.isAssignableFrom(proxyObjectClass)) {
@@ -430,17 +418,11 @@ public class FunctionSignatureFieldFactory extends FieldFactory {
fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return OptionsGui.FUN_NAME.getDefaultColor();
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureSourceFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureSourceFieldFactory.java
index c9761b3c81..218755d3b4 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureSourceFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FunctionSignatureSourceFieldFactory.java
@@ -73,9 +73,6 @@ public class FunctionSignatureSourceFieldFactory extends FieldFactory {
literalColor = options.getColor(OptionsGui.SEPARATOR.getColorOptionName(), Color.BLACK);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getField(ProxyObj, int)
- */
@Override
public ListingField getField(ProxyObj proxy, int varWidth) {
if (!enabled) {
@@ -93,9 +90,6 @@ public class FunctionSignatureSourceFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int row, int col, ListingField bf) {
ProxyObj proxy = bf.getProxy();
@@ -110,9 +104,6 @@ public class FunctionSignatureSourceFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation loc) {
@@ -124,9 +115,6 @@ public class FunctionSignatureSourceFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!Function.class.isAssignableFrom(proxyObjectClass)) {
@@ -142,17 +130,11 @@ public class FunctionSignatureSourceFieldFactory extends FieldFactory {
fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return OptionsGui.SEPARATOR.getDefaultColor();
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/IndentField.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/IndentField.java
index 5849dd4a6f..1f321b48c5 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/IndentField.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/IndentField.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -176,9 +175,6 @@ public class IndentField implements ListingField {
this.startY = startY;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight) {
@@ -224,9 +220,6 @@ public class IndentField implements ListingField {
}
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x < startX) || (x >= startX + fieldWidth) || (y < startY) || (y >= startY + height)) {
@@ -235,65 +228,41 @@ public class IndentField implements ListingField {
return true;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
return startX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return startY;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
return ((row == 0) && (col == 0));
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (!isValid(row, col)) {
@@ -303,9 +272,6 @@ public class IndentField implements ListingField {
return new Rectangle(startX, -heightAbove, 2, height);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
if ((topOfScreen < startY) || (topOfScreen > startY + height)) {
@@ -318,26 +284,17 @@ public class IndentField implements ListingField {
return startY - topOfScreen;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return false;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int newHeightAbove, int newHeightBelow) {
this.heightAbove = newHeightAbove;
this.height = newHeightAbove + newHeightBelow;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return "";
@@ -348,25 +305,16 @@ public class IndentField implements ListingField {
return "";
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return new RowColLocation(0, 0);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return 0;
}
- /**
- * @see ListingField#getClickedObject(FieldLocation)
- */
@Override
public Object getClickedObject(FieldLocation fieldLocation) {
return this;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/InvalidAnnotatedStringHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/InvalidAnnotatedStringHandler.java
index 7c55af0efd..68bf9ebe7e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/InvalidAnnotatedStringHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/InvalidAnnotatedStringHandler.java
@@ -39,18 +39,12 @@ public class InvalidAnnotatedStringHandler implements AnnotatedStringHandler {
this.errorText = errorText;
}
- /**
- * @see AnnotatedStringHandler#createAnnotatedString(AttributedString, String[], ServiceProvider)
- */
@Override
public AttributedString createAnnotatedString(AttributedString prototypeString, String[] text,
Program program) throws AnnotationException {
return new AttributedString(errorText, Color.RED, prototypeString.getFontMetrics(0));
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getSupportedAnnotations()
- */
@Override
public String[] getSupportedAnnotations() {
return new String[0];
@@ -62,17 +56,11 @@ public class InvalidAnnotatedStringHandler implements AnnotatedStringHandler {
return false; // we don't handle clicks!!!
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getDisplayString()
- */
@Override
public String getDisplayString() {
return "Invalid";
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getPrototypeString()
- */
@Override
public String getPrototypeString() {
return "";
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ListingTextField.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ListingTextField.java
index 374744a71a..a7820bb562 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ListingTextField.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ListingTextField.java
@@ -140,33 +140,21 @@ public class ListingTextField implements ListingField, TextField {
this.field = field;
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#setPrimary(boolean)
- */
@Override
public void setPrimary(boolean b) {
field.setPrimary(b);
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#dataToScreenLocation(int, int)
- */
@Override
public RowColLocation dataToScreenLocation(int dataRow, int dataColumn) {
return field.dataToScreenLocation(dataRow, dataColumn);
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#screenToDataLocation(int, int)
- */
@Override
public RowColLocation screenToDataLocation(int screenRow, int screenColumn) {
return field.screenToDataLocation(screenRow, screenColumn);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return field.getWidth();
@@ -177,146 +165,92 @@ public class ListingTextField implements ListingField, TextField {
return field.getPreferredWidth();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return field.getHeight();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return field.getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return field.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return field.getStartX();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight) {
field.paint(c, g, context, map, cursorLoc, rowHeight);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
return field.contains(x, y);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return field.getNumRows();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return field.getNumCols(row);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
return field.getX(row, col);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return field.getY(row);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return field.getRow(y);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
return field.getCol(row, x);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
return field.isValid(row, col);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
return field.getCursorBounds(row, col);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
return field.getScrollableUnitIncrement(topOfScreen, direction, max);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return field.isPrimary();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int heightAbove, int heightBelow) {
field.rowHeightChanged(heightAbove, heightBelow);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return field.getText();
@@ -327,41 +261,26 @@ public class ListingTextField implements ListingField, TextField {
return field.getTextWithLineSeparators();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return field.textOffsetToScreenLocation(textOffset);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return field.screenLocationToTextOffset(row, col);
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getFieldFactory()
- */
@Override
public FieldFactory getFieldFactory() {
return factory;
}
- /**
- * @see java.lang.Object#toString()
- */
@Override
public String toString() {
return getText();
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getProxy()
- */
@Override
public ProxyObj getProxy() {
if (proxy == null) {
@@ -370,25 +289,16 @@ public class ListingTextField implements ListingField, TextField {
return proxy;
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getFieldModel()
- */
@Override
public FieldFormatModel getFieldModel() {
return factory.getFieldModel();
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#isClipped()
- */
@Override
public boolean isClipped() {
return field.isClipped();
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getClickedObject(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public Object getClickedObject(FieldLocation fieldLocation) {
return getFieldElement(fieldLocation.row, fieldLocation.col);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/MnemonicFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/MnemonicFieldFactory.java
index 4836c76a9a..b09be00c41 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/MnemonicFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/MnemonicFieldFactory.java
@@ -97,9 +97,6 @@ public class MnemonicFieldFactory extends FieldFactory {
super.displayOptionsChanged(options, optionName, oldValue, newValue);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
@@ -153,9 +150,6 @@ public class MnemonicFieldFactory extends FieldFactory {
width, hlProvider);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int row, int col, ListingField bf) {
Object obj = bf.getProxy().getObject();
@@ -197,9 +191,6 @@ public class MnemonicFieldFactory extends FieldFactory {
return null;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation programLoc) {
@@ -214,9 +205,6 @@ public class MnemonicFieldFactory extends FieldFactory {
return new FieldLocation(index, fieldNum, 0, loc.getCharOffset());
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!CodeUnit.class.isAssignableFrom(proxyObjectClass)) {
@@ -232,9 +220,6 @@ public class MnemonicFieldFactory extends FieldFactory {
return new MnemonicFieldFactory(formatModel, hsProvider, displayOptions, fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return OptionsGui.MNEMONIC.getDefaultColor();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/OpenCloseField.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/OpenCloseField.java
index b021054c35..8de5278227 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/OpenCloseField.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/OpenCloseField.java
@@ -76,25 +76,16 @@ public class OpenCloseField implements ListingField {
this.toggleHandleSize = OpenCloseField.getOpenCloseHandleSize();
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getFieldFactory()
- */
@Override
public FieldFactory getFieldFactory() {
return factory;
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getFieldModel()
- */
@Override
public FieldFormatModel getFieldModel() {
return factory.getFieldModel();
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getProxy()
- */
@Override
public ProxyObj getProxy() {
if (proxy == null) {
@@ -103,17 +94,11 @@ public class OpenCloseField implements ListingField {
return proxy;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return heightAbove;
}
- /**
- * Returns the heightBelow the imaginary alignment line.
- */
@Override
public int getHeightBelow() {
return heightBelow;
@@ -131,9 +116,6 @@ public class OpenCloseField implements ListingField {
this.heightBelow = heightBelow;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return (indentLevel + 1) * fieldWidth;
@@ -144,17 +126,11 @@ public class OpenCloseField implements ListingField {
return getWidth(); // does the width of this field vary?
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return heightAbove + heightBelow;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
@@ -175,9 +151,6 @@ public class OpenCloseField implements ListingField {
this.startY = startY;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight) {
@@ -249,9 +222,6 @@ public class OpenCloseField implements ListingField {
}
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x < startX) || (x >= startX + fieldWidth) || (y < startY) ||
@@ -261,65 +231,41 @@ public class OpenCloseField implements ListingField {
return true;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
return startX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return startY;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
return ((row == 0) && (col == 0));
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (!isValid(row, col)) {
@@ -329,9 +275,6 @@ public class OpenCloseField implements ListingField {
return new Rectangle(startX, -heightAbove, 2, heightAbove + heightBelow);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
if ((topOfScreen < startY) || (topOfScreen > startY + heightAbove + heightBelow)) {
@@ -344,26 +287,17 @@ public class OpenCloseField implements ListingField {
return startY - topOfScreen;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return false;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int newHeightAbove, int newHeightBelow) {
this.heightAbove = newHeightAbove;
this.heightBelow = newHeightBelow;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return "";
@@ -374,25 +308,16 @@ public class OpenCloseField implements ListingField {
return "";
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return new RowColLocation(0, 0);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return 0;
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getClickedObject(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public Object getClickedObject(FieldLocation fieldLocation) {
return this;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/RegisterTransitionFieldFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/RegisterTransitionFieldFactory.java
index edbbea990d..dcbbd95a44 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/RegisterTransitionFieldFactory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/RegisterTransitionFieldFactory.java
@@ -74,9 +74,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
showContextRegisters = fieldOptions.getBoolean(DISPLAY_HIDDEN_REGISTERS_OPTION_NAME, false);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#fieldOptionsChanged(ghidra.framework.options.ToolOptions, java.lang.String, java.lang.Object, java.lang.Object)
- */
@Override
public void fieldOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
@@ -89,9 +86,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
}
@Override
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getField(int, ghidra.app.util.viewer.proxy.ProxyObj, int)
- */
public void displayOptionsChanged(Options options, String optionName, Object oldValue,
Object newValue) {
super.displayOptionsChanged(options, optionName, oldValue, newValue);
@@ -172,9 +166,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
return valueStr;
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getProgramLocation(int, int, ghidra.app.util.viewer.field.ListingField)
- */
@Override
public ProgramLocation getProgramLocation(int row, int col, ListingField bf) {
Object obj = bf.getProxy().getObject();
@@ -248,9 +239,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
return value1.equals(value2);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getFieldLocation(ghidra.app.util.viewer.field.ListingField, BigInteger, int, ghidra.program.util.ProgramLocation)
- */
@Override
public FieldLocation getFieldLocation(ListingField bf, BigInteger index, int fieldNum,
ProgramLocation programLoc) {
@@ -262,9 +250,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
return new FieldLocation(index, fieldNum, loc.getRow(), loc.getCharOffset());
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#acceptsType(int, java.lang.Class)
- */
@Override
public boolean acceptsType(int category, Class proxyObjectClass) {
if (!CodeUnit.class.isAssignableFrom(proxyObjectClass)) {
@@ -280,9 +265,6 @@ public class RegisterTransitionFieldFactory extends FieldFactory {
fieldOptions);
}
- /**
- * @see ghidra.app.util.viewer.field.FieldFactory#getDefaultColor()
- */
@Override
public Color getDefaultColor() {
return OptionsGui.MNEMONIC.getDefaultColor();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ThunkedFunctionFieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ThunkedFunctionFieldMouseHandler.java
index 68e90424c0..babbde2a93 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ThunkedFunctionFieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/ThunkedFunctionFieldMouseHandler.java
@@ -34,9 +34,6 @@ public class ThunkedFunctionFieldMouseHandler implements FieldMouseHandlerExtens
private final static Class[] SUPPORTED_CLASSES = new Class[] {
ThunkedFunctionFieldLocation.class, FunctionNameFieldLocation.class };
- /**
- * @see FieldMouseHandlerExtension#fieldElementClicked(Object, Navigatable, MouseEvent, ServiceProvider)
- */
@Override
public boolean fieldElementClicked(Object clickedObject, Navigatable navigatable,
ProgramLocation location, MouseEvent mouseEvent, ServiceProvider serviceProvider) {
@@ -85,9 +82,6 @@ public class ThunkedFunctionFieldMouseHandler implements FieldMouseHandlerExtens
return goToService.goTo(navigatable, gotoAddr);
}
- /**
- * @see FieldMouseHandlerExtension#getSupportedProgramLocations()
- */
@Override
public Class[] getSupportedProgramLocations() {
return SUPPORTED_CLASSES;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/URLAnnotatedStringHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/URLAnnotatedStringHandler.java
index a01c9502be..fc08f64810 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/URLAnnotatedStringHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/URLAnnotatedStringHandler.java
@@ -41,9 +41,6 @@ public class URLAnnotatedStringHandler implements AnnotatedStringHandler {
+ "optionally followed by a display string";
private static final String[] SUPPORTED_ANNOTATIONS = { "url", "hyperlink", "href", "link" };
- /**
- * @see AnnotatedStringHandler#createAnnotatedString(AttributedString, String[], ServiceProvider)
- */
@Override
public AttributedString createAnnotatedString(AttributedString prototypeString, String[] text,
Program program) throws AnnotationException {
@@ -74,9 +71,6 @@ public class URLAnnotatedStringHandler implements AnnotatedStringHandler {
prototypeString.getFontMetrics(0), true, prototypeString.getColor(0));
}
- /**
- * @see AnnotatedStringHandler#getSupportedAnnotations()
- */
@Override
public String[] getSupportedAnnotations() {
return SUPPORTED_ANNOTATIONS;
@@ -113,17 +107,11 @@ public class URLAnnotatedStringHandler implements AnnotatedStringHandler {
return false;
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getDisplayString()
- */
@Override
public String getDisplayString() {
return "URL";
}
- /**
- * @see ghidra.app.util.viewer.field.AnnotatedStringHandler#getPrototypeString()
- */
@Override
public String getPrototypeString() {
return "{@url http://www.example.com}";
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/XRefFieldMouseHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/XRefFieldMouseHandler.java
index 8daa40bf46..d3885188fd 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/XRefFieldMouseHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/XRefFieldMouseHandler.java
@@ -40,9 +40,6 @@ public class XRefFieldMouseHandler implements FieldMouseHandlerExtension {
private final static Class[] SUPPORTED_CLASSES =
new Class[] { XRefFieldLocation.class, XRefHeaderFieldLocation.class };
- /**
- * @see FieldMouseHandlerExtension#fieldElementClicked(Object, Navigatable, MouseEvent, ServiceProvider)
- */
@Override
public boolean fieldElementClicked(Object clickedObject, Navigatable sourceNavigatable,
ProgramLocation location, MouseEvent mouseEvent, ServiceProvider serviceProvider) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeader.java
index 36ee041408..41dc4f7d1f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeader.java
@@ -66,7 +66,8 @@ public class FieldHeader extends JTabbedPane implements ChangeListener {
/**
* Constructs a new FieldHeaderPanel
* @param formatMgr the format manager to display tabbed panels for.
- * @param rangeModel the scroll model to coordinate the view for.
+ * @param scroller the scroll model to coordinate the view for.
+ * @param panel the field panel to use.
*/
public FieldHeader(FormatManager formatMgr, IndexedScrollPane scroller, FieldPanel panel) {
this.formatManager = formatMgr;
@@ -81,9 +82,6 @@ public class FieldHeader extends JTabbedPane implements ChangeListener {
addChangeListener(this);
}
- /**
- * @see javax.swing.event.ChangeListener#stateChanged(javax.swing.event.ChangeEvent)
- */
@Override
public void stateChanged(ChangeEvent ev) {
int index = this.getSelectedIndex();
@@ -220,10 +218,10 @@ public class FieldHeader extends JTabbedPane implements ChangeListener {
stateChanged(null);
}
- /**
- * Main test.
- * @param args command line arguments.
- */
+// /**
+// * Main test.
+// * @param args command line arguments.
+// */
// public static void main(String[] args) {
// DockingApplication.initialize(new HeadedDockingApplicationConfiguration());
// try {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeaderComp.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeaderComp.java
index 2a063a232e..e4ae6b1826 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeaderComp.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FieldHeaderComp.java
@@ -63,8 +63,8 @@ public class FieldHeaderComp extends JPanel {
/**
* Constructs a new FieldHeader for the given model.
- * @param formatMgr the format manager
* @param headerPanel the headerPanel containing this component.
+ * @param modelNumber the model number for this component.
*/
public FieldHeaderComp(FieldHeader headerPanel, int modelNumber) {
FormatManager formatMgr = headerPanel.getFormatManager();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FormatManager.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FormatManager.java
index f965d22cd3..b68562289d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FormatManager.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/FormatManager.java
@@ -180,7 +180,7 @@ public class FormatManager implements OptionsChangeListener {
/**
* Returns the format model for the given index.
*
- * @param inde the index of the format model to return.
+ * @param index the index of the format model to return.
*/
public FieldFormatModel getModel(int index) {
return models[index];
@@ -216,14 +216,6 @@ public class FormatManager implements OptionsChangeListener {
/**
* Returns the format model for a code unit.
- *
- * @param cu
- * the code unit for which to get a model. The cu is used in case
- * there is a custom format for it.
- * @param useCustomFormats
- * if true seaches for a custom format for the code unit,
- * otherwise always returns the basic instruction/data format
- * model.
*/
public FieldFormatModel getCodeUnitFormat() {
return models[FieldFormatModel.INSTRUCTION_OR_DATA];
@@ -234,9 +226,6 @@ public class FormatManager implements OptionsChangeListener {
*
* @param data
* the data code unit to get the format model for.
- * @param useCustomFormats
- * if true, tries to find a custom format model, otherwise always
- * uses the default open data model.
*/
public FieldFormatModel getOpenDataFormat(Data data) {
@@ -288,7 +277,7 @@ public class FormatManager implements OptionsChangeListener {
/**
* Notifies listeners that the given model has changed.
*
- * @param mode the format model that changed.
+ * @param model the format model that changed.
*/
public void modelChanged(FieldFormatModel model) {
if (!initialized) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/AddAllFieldAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/AddAllFieldAction.java
index 396f93ea00..b6cc5b3428 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/AddAllFieldAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/AddAllFieldAction.java
@@ -33,7 +33,6 @@ public class AddAllFieldAction extends DockingAction {
* Constructor takes the CodeBrowserPlugin that created it and the header
* component so that it can be repainted when fields are added.
* @param owner the action owner
- * @param model the model this action affects
* @param panel the listing panel.
*/
public AddAllFieldAction(String owner, FieldHeader panel) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/DisableFieldAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/DisableFieldAction.java
index 6f269a2c76..383e895806 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/DisableFieldAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/DisableFieldAction.java
@@ -46,9 +46,6 @@ public class DisableFieldAction extends DockingAction {
setHelpLocation(new HelpLocation(HelpTopics.CODE_BROWSER, "Disable Field"));
}
- /**
- * @see docking.DockingAction#isEnabledForContext(java.lang.Object)
- */
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
@@ -60,9 +57,6 @@ public class DisableFieldAction extends DockingAction {
return false;
}
- /**
- * Method called when the action is invoked.
- */
@Override
public void actionPerformed(ActionContext context) {
FieldFactory factory = loc.getFieldFactory();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/EnableFieldAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/EnableFieldAction.java
index 7e38d63b53..9bb8f8d0ce 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/EnableFieldAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/EnableFieldAction.java
@@ -44,9 +44,6 @@ public class EnableFieldAction extends DockingAction {
setHelpLocation(new HelpLocation(HelpTopics.CODE_BROWSER, "Enable Field"));
}
- /**
- * @see docking.DockingAction#isEnabledForContext(java.lang.Object)
- */
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
@@ -58,9 +55,6 @@ public class EnableFieldAction extends DockingAction {
return false;
}
- /**
- * Method called when the action is invoked.
- */
@Override
public void actionPerformed(ActionContext context) {
FieldFactory factory = loc.getFieldFactory();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/InsertRowAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/InsertRowAction.java
index 6f79dfe285..c9516edfc5 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/InsertRowAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/InsertRowAction.java
@@ -40,9 +40,6 @@ public class InsertRowAction extends DockingAction {
setHelpLocation(new HelpLocation(HelpTopics.CODE_BROWSER, "Insert Row"));
}
- /**
- * @see docking.DockingAction#isEnabledForContext(java.lang.Object)
- */
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
@@ -55,9 +52,6 @@ public class InsertRowAction extends DockingAction {
return false;
}
- /**
- * Method called when the action is invoked.
- */
@Override
public void actionPerformed(ActionContext context) {
panel.setTabLock( true );
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveAllFieldsAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveAllFieldsAction.java
index 0846337a8f..fc454ded58 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveAllFieldsAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveAllFieldsAction.java
@@ -32,8 +32,8 @@ public class RemoveAllFieldsAction extends DockingAction {
/**
* Constructor takes the CodeBrowserPlugin that created it and the header
* component so that it can be repainted when fields are added.
- * @param owner the action owner
- * @param model the mode from which to remove all fields
+ * @param owner the action owner.
+ * @param panel the listing panel.
*/
public RemoveAllFieldsAction(String owner, FieldHeader panel) {
super("Remove All Fields", owner, false);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveFieldAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveFieldAction.java
index 60889af60a..348f81bf01 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveFieldAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveFieldAction.java
@@ -39,9 +39,6 @@ public class RemoveFieldAction extends DockingAction {
setHelpLocation(new HelpLocation(HelpTopics.CODE_BROWSER, "Remove Field"));
}
- /**
- * @see docking.DockingAction#isEnabledForContext(java.lang.Object)
- */
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
@@ -52,9 +49,6 @@ public class RemoveFieldAction extends DockingAction {
return false;
}
- /**
- * Method called when the action is invoked.
- */
@Override
public void actionPerformed(ActionContext context) {
panel.setTabLock( true );
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveRowAction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveRowAction.java
index 44ff90a1e7..0ee7c5e216 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveRowAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/format/actions/RemoveRowAction.java
@@ -37,9 +37,6 @@ public class RemoveRowAction extends DockingAction {
setHelpLocation(new HelpLocation(HelpTopics.CODE_BROWSER, "Remove Row"));
}
- /**
- * @see docking.DockingAction#isEnabledForContext(java.lang.Object)
- */
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
@@ -52,9 +49,6 @@ public class RemoveRowAction extends DockingAction {
return false;
}
- /**
- * Method called when the action is invoked.
- */
@Override
public void actionPerformed(ActionContext context) {
panel.setTabLock( true );
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModel.java
index ddc9b14649..b5123b87be 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModel.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModel.java
@@ -53,7 +53,7 @@ public interface ListingModel {
public boolean isOpen(Data data);
/**
- * Changes the open state of the given data (open -> closes; closed-> open).
+ * Changes the open state of the given data (open -> closes; closed-> open).
*
* @param data the data to open
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModelListener.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModelListener.java
index 67f48cf43e..e0b91cf061 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModelListener.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingModelListener.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,8 +25,7 @@ public interface ListingModelListener {
/**
* Called when the data at an index or range of indexes changes.
- * @param start the starting address for the region of data changes.
- * @param end the ending address (inclusive) for the region of data changes.
+ * @param updateImmediately true to immediately update the listing upon change.
*
*/
void dataChanged(boolean updateImmediately);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/base/project/GhidraProject.java b/Ghidra/Features/Base/src/main/java/ghidra/base/project/GhidraProject.java
index bee83fdd76..14a46ad8d6 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/base/project/GhidraProject.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/base/project/GhidraProject.java
@@ -452,8 +452,6 @@ public class GhidraProject {
* @param overWrite
* if true, any existing program with that name will be
* over-written.
- * @throws DuplicateNameException
- * if a file exists with that name and overwrite is false or overwrite failed
* @throws InvalidNameException
* the name is null or has invalid characters.
* @throws IOException
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java
index 311e017d10..6c45e5026d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/AbstractFileExtractorTask.java
@@ -62,10 +62,9 @@ public abstract class AbstractFileExtractorTask extends Task {
*
* @param fs the {@link GFileSystem} that holds the files
* @param srcDir the starting directory to extract, if {@code null}, start at root of file system
- * @param rootOutputDirectory the destination directory
* @param monitor {@link TaskMonitor} that will be updated with progress and checked for cancel
- * @throws CancelledException
- * @throws IOException
+ * @throws CancelledException if the extraction is cancelled.
+ * @throws IOException if an exception occurs extracting the files.
*/
protected void startExtract(GFileSystem fs, GFile srcDir, TaskMonitor monitor)
throws CancelledException, IOException {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/DerivedFilePushProducer.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/DerivedFilePushProducer.java
index 94f0cd1d04..e02095300d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/DerivedFilePushProducer.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/DerivedFilePushProducer.java
@@ -22,13 +22,13 @@ import java.io.IOException;
import java.io.OutputStream;
/**
- * Used by {@link FileSystemService#getDerivedFilePushInfo(FSRL, String, DerivedFilePushProducer, TaskMonitor)}
+ * Used by {@link FileSystemService#getDerivedFilePush(FSRL, String, DerivedFilePushProducer, TaskMonitor)}
* to produce a derived file from a source file.
*/
public interface DerivedFilePushProducer {
/**
* Callback method intended to be implemented by the caller to
- * {@link FileSystemService#getDerivedFilePushInfo(FSRL, String, DerivedFileProducer, TaskMonitor)}.
+ * {@link FileSystemService#getDerivedFilePush(FSRL, String, DerivedFilePushProducer, TaskMonitor)}.
*
* The implementation needs to write bytes to the supplied {@link OutputStream}.
*
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java
index 7d8e1c9ef2..1c8a6d4f9d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSRLRoot.java
@@ -27,10 +27,11 @@ package ghidra.formats.gfilesystem;
*
* - FSRLRoot [ file:// ]
* "file://"
- * - FSRLRoot [ file:// ] <---- FSRL [ /filename.txt ]
+ * - {@literal FSRLRoot [ file:// ] <---- FSRL [ /filename.txt ]}
* "file:///filename.txt"
- * - FSRLRoot [ file:// ] <---- FSRL [ /filename.txt ] <--- FSRLRoot [ subfs:// ]
+ * - {@literal FSRLRoot [ file:// ] <---- FSRL [ /filename.txt ] <--- FSRLRoot [ subfs:// ]}
* "file:///filename.txt|subfs://"
+ *
*/
public class FSRLRoot extends FSRL {
/**
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java
index e3f62536ec..a8871bd11d 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FSUtilities.java
@@ -78,7 +78,7 @@ public class FSUtilities {
};
/**
- * Converts a string -> string mapping into a "key: value" multi-line string.
+ * Converts a string -> string mapping into a "key: value" multi-line string.
*
* @param info map of string key to string value.
* @return Multi-line string "key: value" string.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java
index 668b64b270..8a1c334cb8 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileCache.java
@@ -263,7 +263,7 @@ public class FileCache {
*
* @param pusher functional callback that will accept an {@link OutputStream} and write
* to it.
- * (os) -> { os.write(.....); }
+ * (os) -> { os.write(.....); }
* @param monitor {@link TaskMonitor} that will be checked for cancel and updated with
* file io progress.
* @return a new {@link FileCacheEntry} with the newly added cache file's File and MD5,
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java
index 55cef99a75..81009360e1 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemIndexHelper.java
@@ -208,7 +208,7 @@ public class FileSystemIndexHelper {
}
/**
- * Returns a string->GFile map that holds the contents of a single directory.
+ * Returns a string->GFile map that holds the contents of a single directory.
* @param directoryFile
* @return
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java
index 8e217d6a36..731695e48f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/FileSystemService.java
@@ -42,7 +42,7 @@ import ghidra.util.timer.GTimer;
* is always valid and does not force the instantiation of parent objects)
*
* {@link GFileSystem Filesystems} should be used via {@link FileSystemRef filesystem ref}
- * handles that ensure the filesystem is pinned in memory and won't be close()ed while
+ * handles that ensure the filesystem is pinned in memory and won't be closed while
* you are using it.
*
* If you are working with {@link GFile} instances, you should have a
@@ -51,15 +51,15 @@ import ghidra.util.timer.GTimer;
* Thread-safe.
*
*
- *
+ *
{@literal
* TODO list:
*
* Refactor fileInfo -> needs dialog to show properties
* Refactor GFile.getInfo() to return Map<> instead of String.
- * Persistant filesystem - when reopen tool, filesystems should auto-reopen
- * Unify GhidraFileChooser with GFileSystem
- * add "Mounted Filesystems" button to show currently opened GFilesystems?
- * Dockable filesystem browser in FrontEnd
+ * Persistant filesystem - when reopen tool, filesystems should auto-reopen.
+ * Unify GhidraFileChooser with GFileSystem.
+ * Add "Mounted Filesystems" button to show currently opened GFilesystems?
+ * Dockable filesystem browser in FrontEnd.
* Reorg filesystem browser right-click popup menu to be more Eclipse action-like
* Show In -> Project tree
* Tool [CodeBrowser name]
@@ -78,7 +78,7 @@ import ghidra.util.timer.GTimer;
*
* More format tests
* Large test binary support
- *
+ * }
*/
public class FileSystemService {
private static int FSRL_INTERN_SIZE = 1000;
@@ -452,7 +452,7 @@ public class FileSystemService {
* @param derivedName a unique string identifying the derived file inside the source (or container) file
* @param producer a {@link DerivedFileProducer callback or lambda} that returns an
* {@link InputStream} that will be streamed into a file and placed into the file cache.
- * Example: (file) -> { return new XYZDecryptorInputStream(file); }
+ * Example:{@code (file) -> { return new XYZDecryptorInputStream(file); }}
* @param monitor {@link TaskMonitor} that will be monitor for cancel requests and updated
* with file io progress
* @return {@link FileCacheEntry} with file and md5 fields
@@ -493,7 +493,7 @@ public class FileSystemService {
* @param fsrl {@link FSRL} of the source (or container) file that this derived file is based on
* @param derivedName a unique string identifying the derived file inside the source (or container) file
* @param pusher a {@link DerivedFilePushProducer callback or lambda} that recieves a {@link OutputStream}.
- * Example: (os) -> { ...write to outputstream os here...; }
+ * Example:{@code (os) -> { ...write to outputstream os here...; }}
* @param monitor {@link TaskMonitor} that will be monitor for cancel requests and updated
* with file io progress
* @return {@link FileCacheEntry} with file and md5 fields
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
index 7fd0519d5a..ed7143acb5 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
@@ -153,7 +153,7 @@ public interface GFileSystem extends Closeable, ExtensionPoint {
/**
* Returns a multi-line string with information about the specified {@link GFile file}.
*
- * TODO: this method needs to be refactored to return a Map instead of
+ * TODO:{@literal this method needs to be refactored to return a Map; instead of}
* a pre-formatted multi-line string.
*
* @param file {@link GFile} to get info message for.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java
index c4c586321a..19a2af6294 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/annotations/FileSystemInfo.java
@@ -24,9 +24,10 @@ import java.lang.annotation.*;
* Specifies the info needed of a {@link GFileSystem} implementation.
*
*
- * - {@link #type()} is required.
- *
- {@link #description()} is optional.
- *
- {@link #factory()} is required.
+ *
- {@link #type()} is required.
+ * - {@link #description()} is optional.
+ * - {@link #factory()} is required.
+ *
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java
index 651183a67a..676d80a80e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java
@@ -465,7 +465,7 @@ public class DataTreeDialog extends DialogComponentProvider
/**
* Define the Main panel for the dialog here.
- * @return JPanel the completed Main Panel<\CODE>
+ * @return JPanel the completed Main Panel
*/
protected JPanel buildMainPanel() {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java
index cf3c03d8a8..4b55af2220 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java
@@ -32,7 +32,7 @@ import ghidra.util.Msg;
import util.CollectionUtils;
/**
- * A drag-and-drop handler for trees that is specific to List<File>. (see
+ * {@literal A drag-and-drop handler for trees that is specific to List.} (see
* {@link DataFlavor#javaFileListFlavor}).
*/
public final class JavaFileListHandler implements DataTreeFlavorHandler, FileOpenDataFlavorHandler {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/VersionControlDataTypeArchiveUndoCheckoutAction.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/VersionControlDataTypeArchiveUndoCheckoutAction.java
index ba65b703ce..5131cc1824 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/VersionControlDataTypeArchiveUndoCheckoutAction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/VersionControlDataTypeArchiveUndoCheckoutAction.java
@@ -132,9 +132,8 @@ public class VersionControlDataTypeArchiveUndoCheckoutAction extends VersionCont
* user chooses to do so.
* All unmodified checkouts will be undone. Only modified checkouts the user chooses
* will be undone.
- * @param unmodifiedCheckOutsList the list of unmodified checked out files
- * @param modifiedArchivesList the list of checked out files that have been modified
- * @param changedList the list of checked out files that have been modified and not yet saved
+ * @param unmodifiedArchivesList the list of unmodified archives
+ * @param modifiedArchivesList the list of archives that have been modified
* @throws CancelledException
*/
protected void undoCheckOuts(List unmodifiedArchivesList,
@@ -204,8 +203,8 @@ public class VersionControlDataTypeArchiveUndoCheckoutAction extends VersionCont
}
/**
- *
- * @param changedList
+ * Saves all checked out changes.
+ * @param changedList the list of changes
*/
protected void saveCheckOutChanges(List changedList) throws CancelledException {
if (changedList.size() > 0) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/plugin/importer/ProgramMappingService.java b/Ghidra/Features/Base/src/main/java/ghidra/plugin/importer/ProgramMappingService.java
index 63bd2783e3..d4545f7081 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/plugin/importer/ProgramMappingService.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/plugin/importer/ProgramMappingService.java
@@ -42,10 +42,10 @@ import ghidra.util.task.TaskMonitor;
* Threadsafe.
*
* The current implementation searches current open Ghidra Programs and maintains a
- * short-lived, in-memory only mapping of FSRL->DomainFile paths
+ * short-lived, in-memory only mapping of FSRL->DomainFile paths
* (manually updated by users of the ProgramMappingService when
* they do an import or other operation that creates a Ghidra DomainFile by calling
- * {@link #createAssociation(FSLR, DomainFile)} and friends.)
+ * {@link #createAssociation(FSRL, DomainFile)} and friends.)
*
* [1] - best-effort (adverb): meaning a dirty hack.
*/
@@ -293,7 +293,7 @@ public class ProgramMappingService {
*
* (ie. an open program has a MD5 or FSRL metadata value that matches the file)
*
- * See also {@link #isFileOpen(GFile)}.
+ * See also {@link #isFileOpen(FSRL)}.
*
* @param fsrl {@link FSRL} to use when inspecting each open Program's metadata.
* @param consumer Object that will be used to pin the matching Program open. Caller
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchSegregatingCriteria.java b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchSegregatingCriteria.java
index 84ef345780..d01eba03ce 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchSegregatingCriteria.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/plugins/importer/batch/BatchSegregatingCriteria.java
@@ -29,9 +29,10 @@ import ghidra.app.util.opinion.Loader;
*
* Criteria are:
*
- * - Filename extension of source file
- *
- Loader name
- *
- Set of LanguageCompilerSpecs & preferred flags (ie. {@link BatchGroupLoadSpec})
+ *
- Filename extension of source file
+ * - Loader name
+ * - Set of LanguageCompilerSpecs and preferred flags (ie. {@link BatchGroupLoadSpec})
+ *
*/
public class BatchSegregatingCriteria {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java
index a6ef1260ea..94031eb87e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/database/ProgramBuilder.java
@@ -116,7 +116,6 @@ public class ProgramBuilder {
* Construct program builder using specified language and default compiler spec
* @param name program name
* @param languageName supported language ID (includes all Toy language IDs)
- * @param compilerSpecID compiler specification ID (if null default spec will be used)
* @param consumer program consumer (if null this builder will be used as consumer and must be disposed to release program)
* @throws Exception
*/
@@ -368,7 +367,7 @@ public class ProgramBuilder {
*
* @param address String containing numeric value, preferably hex encoded: "0x1004000"
* @param byteString String containing 2 digit hex values, separated by ' ' space chars
- * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseBytes(String)}.
+ * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseHexLong(String)}.
* @throws Exception
*/
public void setBytes(String address, String byteString) throws Exception {
@@ -384,7 +383,7 @@ public class ProgramBuilder {
*
* @param address String containing numeric value, preferably hex encoded: "0x1004000"
* @param byteString String containing 2 digit hex values, separated by ' ' space chars
- * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseBytes(String)}.
+ * or by comma ',' chars: "12 05 ff". See {@link NumericUtilities#parseHexLong(String)}.
* @param disassemble boolean flag.
* @throws Exception
*/
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 222b3079b7..8c1678b6dc 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
@@ -29,6 +29,7 @@ import ghidra.app.plugin.core.analysis.AutoAnalysisManager;
import ghidra.app.plugin.core.clear.ClearCmd;
import ghidra.app.plugin.core.clear.ClearOptions;
import ghidra.app.plugin.core.searchmem.RegExSearchData;
+import ghidra.app.script.GhidraScript;
import ghidra.framework.main.AppInfo;
import ghidra.framework.model.*;
import ghidra.framework.plugintool.PluginTool;
@@ -511,13 +512,13 @@ public class FlatProgramAPI {
/**
* Returns the PLATE comment at the specified address. The comment returned is the raw text
- * of the comment. Contrastingly, calling {@link #getPlateCommentAsRendered(Address)} will
+ * of the comment. Contrastingly, calling {@link GhidraScript#getPlateCommentAsRendered(Address)} will
* return the text of the comment as it is rendered in the display.
*
* @param address the address to get the comment
* @return the PLATE comment at the specified address or null
* if one does not exist
- * @see #getPlateCommentAsRendered(Address)
+ * @see GhidraScript#getPlateCommentAsRendered(Address)
*/
public final String getPlateComment(Address address) {
return currentProgram.getListing().getComment(CodeUnit.PLATE_COMMENT, address);
@@ -525,13 +526,13 @@ public class FlatProgramAPI {
/**
* Returns the PRE comment at the specified address. The comment returned is the raw text
- * of the comment. Contrastingly, calling {@link #getPreCommentAsRendered(Address)} will
+ * of the comment. Contrastingly, calling {@link GhidraScript#getPreCommentAsRendered(Address)} will
* return the text of the comment as it is rendered in the display.
*
* @param address the address to get the comment
* @return the PRE comment at the specified address or null
* if one does not exist
- * @see #getPreCommentAsRendered(Address)
+ * @see GhidraScript#getPreCommentAsRendered(Address)
*/
public final String getPreComment(Address address) {
return currentProgram.getListing().getComment(CodeUnit.PRE_COMMENT, address);
@@ -539,13 +540,13 @@ public class FlatProgramAPI {
/**
* Returns the POST comment at the specified address. The comment returned is the raw text
- * of the comment. Contrastingly, calling {@link #getPostCommentAsRendered(Address)} will
+ * of the comment. Contrastingly, calling {@link GhidraScript#getPostCommentAsRendered(Address)} will
* return the text of the comment as it is rendered in the display.
*
* @param address the address to get the comment
* @return the POST comment at the specified address or null
* if one does not exist
- * @see #getPostCommentAsRendered(Address)
+ * @see GhidraScript#getPostCommentAsRendered(Address)
*/
public final String getPostComment(Address address) {
return currentProgram.getListing().getComment(CodeUnit.POST_COMMENT, address);
@@ -553,12 +554,12 @@ public class FlatProgramAPI {
/**
* Returns the EOL comment at the specified address. The comment returned is the raw text
- * of the comment. Contrastingly, calling {@link #getEOLCommentAsRendered(Address)} will
+ * of the comment. Contrastingly, calling {@link GhidraScript#getEOLCommentAsRendered(Address)} will
* return the text of the comment as it is rendered in the display.
* @param address the address to get the comment
* @return the EOL comment at the specified address or null
* if one does not exist
- * @see #getEOLCommentAsRendered(Address)
+ * @see GhidraScript#getEOLCommentAsRendered(Address)
*/
public final String getEOLComment(Address address) {
return currentProgram.getListing().getComment(CodeUnit.EOL_COMMENT, address);
@@ -624,9 +625,9 @@ public class FlatProgramAPI {
}
/**
- * Finds the first occurrences of the byte array sequence that matches 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.
+ * Finds the first {@code } occurrences of the byte array sequence that matches
+ * 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
* highlights some example search strings (note the use of double backslashes ("\\")):
@@ -650,9 +651,9 @@ public class FlatProgramAPI {
}
/**
- * Finds the first occurrences of the byte array sequence that matches 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.
+ * Finds the first {@code } occurrences of the byte array sequence that matches
+ * 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
* highlights some example search strings (note the use of double backslashes ("\\")):
@@ -1180,7 +1181,7 @@ public class FlatProgramAPI {
* Returns the instruction defined before the specified address or null
* if no instruction exists.
* The instruction that is returned does not have to be contiguous.
- * @param instruction the instruction
+ * @param address the address of the instruction
* @return the instruction defined before the specified address or null if no instruction exists
*/
public final Instruction getInstructionBefore(Address address) {
@@ -1202,7 +1203,7 @@ public class FlatProgramAPI {
* Returns the instruction defined after the specified address or null
* if no instruction exists.
* The instruction that is returned does not have to be contiguous.
- * @param instruction the instruction
+ * @param address the address of the prior instruction
* @return the instruction defined after the specified address or null if no instruction exists
*/
public final Instruction getInstructionAfter(Address address) {
@@ -1255,7 +1256,7 @@ public class FlatProgramAPI {
/**
* Returns the defined data before the specified data or null if no data exists.
- * @param address the data address
+ * @param data the succeeding data
* @return the defined data before the specified data or null if no data exists
*/
public final Data getDataBefore(Data data) {
@@ -1273,7 +1274,7 @@ public class FlatProgramAPI {
/**
* Returns the defined data after the specified data or null if no data exists.
- * @param address the data address
+ * @param data preceeding data
* @return the defined data after the specified data or null if no data exists
*/
public final Data getDataAfter(Data data) {
@@ -1388,7 +1389,7 @@ public class FlatProgramAPI {
/**
* Returns the previous non-default primary symbol defined
* after the previous address.
- * @param symbol the symbol to use as a starting point
+ * @param address the address to use as a starting point
* @return the next non-default primary symbol
*/
public final Symbol getSymbolBefore(Address address) {
@@ -1796,8 +1797,7 @@ public class FlatProgramAPI {
/**
* Returns a new address inside the specified program as indicated by the string.
- * @param p the program to use for determining the address
- * @param s string representation of the address desired
+ * @param addressString string representation of the address desired
* @return the address. Otherwise, return null if the string fails to evaluate
* to a legitimate address
*/
@@ -1843,7 +1843,7 @@ public class FlatProgramAPI {
/**
* Sets the 'byte' values starting at the specified address.
* @param address the address to set the bytes
- * @param second the values to set
+ * @param values the values to set
* @throws MemoryAccessException if memory does not exist or is uninitialized
*/
public final void setBytes(Address address, byte[] values) throws MemoryAccessException {
@@ -2303,7 +2303,6 @@ public class FlatProgramAPI {
* Removes the equates defined at the operand index of the instruction.
* @param instruction the instruction
* @param operandIndex the operand index
- * @param second scalar value corresponding to equate
*/
public final void removeEquates(Instruction instruction, int operandIndex) {
Address address = instruction.getMinAddress();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/AddressTranslator.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/AddressTranslator.java
index c34c9a9e8b..07b3d333cf 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/AddressTranslator.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/AddressTranslator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -59,7 +58,7 @@ public interface AddressTranslator {
* This interface is intended to translate an address range from the source program to an
* address range in the destination program.
*
This method should be implemented if isOneForOneTranslator() returns true.
- * @param sourceAddressSet the source address set to be converted.
+ * @param sourceAddressRange the source address range to be converted.
* @return the destination address range that is equivalent in some way to the source address range.
* How the address range is equivalent depends upon the particular translator.
* throws AddressTranslationException if the address set can't be translated to an equivalent
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java
index 2f2e697db3..24f1ed4fd1 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiff.java
@@ -1354,8 +1354,7 @@ public class ProgramDiff {
for (BookmarkType element : types2) {
boolean found = false;
- for (int i = 0; i < list.size(); ++i) {
- BookmarkType type = list.get(i);
+ for (BookmarkType type : list) {
if (element.getTypeString().compareTo(type.getTypeString()) == 0) {
found = true;
break;
@@ -3202,7 +3201,7 @@ public class ProgramDiff {
}
/** An IteratorWrapper provides a common class for accessing the methods
- * for several different iterator types (Iterator, CodeUnitIterator, &
+ * for several different iterator types (Iterator, CodeUnitIterator, and
* AddressIterator).
*/
private static class IteratorWrapper {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryComparator.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryComparator.java
index e4d5c8a1c5..7437d64efb 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryComparator.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryComparator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -66,7 +65,7 @@ public class ProgramMemoryComparator {
private AddressSet compatibleOnlyInTwo;
/**
- * ProgramMemoryComparator/CODE> is used to determine the memory
+ * ProgramMemoryComparator is used to determine the memory
* address differences between two programs.
*
* @param program1 the first program
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryUtil.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryUtil.java
index 0c89c48bec..f87cc044b4 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryUtil.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMemoryUtil.java
@@ -413,11 +413,9 @@ public class ProgramMemoryUtil {
* Direct references are only found at addresses that match the indicated alignment.
* @param program the program whose memory is to be checked.
* @param alignment direct references are to only be found at the indicated alignment in memory.
- * @param toAddressSet the set of addresses that we are interested in finding references to.
- * @param directReferenceList the list to be populated with possible direct references
+ * @param codeUnit the code unit to to search for references to.
* @param monitor a task monitor for progress or to allow canceling.
- * @return list of addresses referring directly to the toAddress
- * @throws CancelledException if the user cancels via the monitor.
+ * @return list of addresses referring directly to the toAddress.
*/
public static List findDirectReferencesCodeUnit(Program program, int alignment,
CodeUnit codeUnit, TaskMonitor monitor) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java
index 2f049102bb..fc7c1a24c5 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMerge.java
@@ -98,7 +98,7 @@ public class ProgramMerge implements PropertyVisitor {
* which changes are made.
* The source program from the translator is the origin program for obtaining the changes.
*
- * @param addressTranslator converts addresses from the origin program into an
+ * @param originToResultTranslator converts addresses from the origin program into an
* equivalent address in the destination program.
* @see AddressTranslator
*/
@@ -490,13 +490,13 @@ public class ProgramMerge implements PropertyVisitor {
// **** CODE UNIT methods ****
/**
- * mergeCodeUnits merges all instructions &/or data
+ * mergeCodeUnits merges all instructions and/or data
* (as indicated) in the specified address set from the origin program.
* It merges them into the result program. When merging
* instructions, the bytes are also replaced if they differ.
* This assumes originToResultTranslator maps address spaces and does
* not do fine-grained mapping of addresses.
- * @param addrSet the addresses to be merged.
+ * @param originAddressSet the addresses to be merged.
* The addresses in this set should be derived from the origin program.
* @param byteDiffs address set indicating addresses where the bytes differ
* between the result program and the origin program.
@@ -1141,13 +1141,13 @@ public class ProgramMerge implements PropertyVisitor {
originToResultMap.put(origRef, resultRef);
}
// Remove references we don't need any more or those that are there but not the same.
- for (int i = 0; i < resultRefs.length; i++) {
+ for (Reference resultRef : resultRefs) {
// Leave fallthroughs as they are, so the code unit merge can handle them.
- if (resultRefs[i].getReferenceType().isFallthrough()) {
+ if (resultRef.getReferenceType().isFallthrough()) {
continue;
}
- if (!originToResultMap.containsKey(resultRefs[i])) {
- resultRM.delete(resultRefs[i]);
+ if (!originToResultMap.containsKey(resultRef)) {
+ resultRM.delete(resultRef);
}
}
// Add the references that aren't there yet and those that weren't the same.
@@ -1260,9 +1260,9 @@ public class ProgramMerge implements PropertyVisitor {
resultsToKeep.put(originRef, resultRef); // resultRef may be null
}
// Remove references we don't need any more or those that are there but not the same.
- for (int i = 0; i < resultRefs.length; i++) {
- if (!resultsToKeep.containsValue(resultRefs[i])) {
- resultRM.delete(resultRefs[i]);
+ for (Reference resultRef : resultRefs) {
+ if (!resultsToKeep.containsValue(resultRef)) {
+ resultRM.delete(resultRef);
}
}
// Add the references that aren't there yet and those that weren't the same.
@@ -1610,7 +1610,7 @@ public class ProgramMerge implements PropertyVisitor {
* type in program1 with the comment in program2 at the specified address.
* @param commentType comment type to merge (from CodeUnit class).
*
EOL_COMMENT, PRE_COMMENT, POST_COMMENT, REPEATABLE_COMMENT, OR PLATE_COMMENT.
- * @param addr the address
+ * @param originAddress the address
* This address should be derived from the origin program.
*/
public void mergeComments(int commentType, Address originAddress) {
@@ -1626,7 +1626,7 @@ public class ProgramMerge implements PropertyVisitor {
* type in program1 with the comment in program2 at the specified address.
* @param commentType comment type to replace (from CodeUnit class).
*
EOL_COMMENT, PRE_COMMENT, POST_COMMENT, REPEATABLE_COMMENT, OR PLATE_COMMENT.
- * @param addr the address
+ * @param originAddress the address
* This address should be derived from the origin program.
*/
public void replaceComment(int commentType, Address originAddress) {
@@ -2271,9 +2271,8 @@ public class ProgramMerge implements PropertyVisitor {
* mergeFunctionReturn replaces the return type/storage of the
* function in program1 with the return type/storage of the function in program2
* at the specified entry point address.
- * @param entry the entry point address of the function.
+ * @param entry2 the entry point address of the function.
* This address should be derived from the origin program.
- * @param monitor the task monitor for notifying the user of this merge's progress.
*/
public void mergeFunctionReturn(Address entry2) {
Address entry = originToResultTranslator.getAddress(entry2);
@@ -2361,11 +2360,9 @@ public class ProgramMerge implements PropertyVisitor {
* mergeFunctionName replaces the name of the
* function in program1 with the name of the function in program2
* at the specified entry point address.
- * @param entry the entry point address of the function.
+ * @param entry2 the entry point address of the function.
* This address should be derived from the origin program.
* @param monitor the task monitor for notifying the user of this merge's progress.
- * @throws InvalidInputException
- * @throws DuplicateNameException
*/
public void mergeFunctionName(Address entry2, TaskMonitor monitor) {
Address entry = originToResultTranslator.getAddress(entry2);
@@ -3423,12 +3420,11 @@ public class ProgramMerge implements PropertyVisitor {
/**
* replaceFunctionVariable replaces the name of the indicated
* function variable in program1 with that from the origin program.
- * @param entry the entry point address of the function to modify.
+ * @param originEntryPoint the entry point address of the function to modify.
* This address should be derived from program1.
* @param var a variable that is equivalent to the one in program1 to be replaced.
* The variable passed here could be from another program.
* @param monitor the task monitor for notifying the user of progress.
- * @throws DuplicateNameException
*/
public void replaceFunctionVariable(Address originEntryPoint, Variable var,
TaskMonitor monitor) {
@@ -3471,12 +3467,11 @@ public class ProgramMerge implements PropertyVisitor {
/**
* replaceFunctionVariables replaces the
* function variables/parameters in program1 with that from the origin program.
- * @param entry the entry point address of the function to modify.
+ * @param originEntryPoint the entry point address of the function to modify.
* This address should be derived from program1.
- * @param var a variable that is equivalent to the one in program1 to be replaced.
- * The variable passed here could be from another program.
+ * @param varList the list of variables to replace.
* @param monitor the task monitor for notifying the user of progress.
- * @throws DuplicateNameException
+ * @throws CancelledException if the user canceled the operation via the task monitor.
*/
public void replaceVariables(Address originEntryPoint, List varList,
TaskMonitor monitor) throws CancelledException {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMergeManager.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMergeManager.java
index 5b35e423c0..d7b533a078 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMergeManager.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramMergeManager.java
@@ -549,7 +549,7 @@ public class ProgramMergeManager {
}
/**
- * mergeCodeUnits merges all instructions &/or data
+ * mergeCodeUnits merges all instructions and/or data
* (as indicated) in the specified address set from the second program.
* It merges them into the merge program. When merging
* instructions, the bytes are also moved if they differ.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java
index 39157d281d..92d9d11f45 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java
@@ -125,10 +125,13 @@ public class SymbolicPropogator {
* Process a subroutine using the processor function.
* The process function can control what flows are followed and when to stop.
*
- * @param entryPoint start address
- * @param processor processor to use
+ * @param startAddr start address
+ * @param restrictSet the address set to restrict the constant flow to
+ * @param eval the context evaluator to use
+ * @param saveContext true if the context should be saved
+ * @param monitor the task monitor
* @return the address set of instructions that were followed
- * @throws CancelledException
+ * @throws CancelledException if the task is cancelled
*/
public AddressSet flowConstants(Address startAddr, AddressSetView restrictSet,
ContextEvaluator eval, boolean saveContext, TaskMonitor monitor)
@@ -278,7 +281,7 @@ public class SymbolicPropogator {
/**
* Get constant or register relative value assigned to the
* specified register at the specified address
- * @param addr address
+ * @param toAddr address
* @param reg register
* @return register value
*/
@@ -2165,14 +2168,14 @@ public class SymbolicPropogator {
* The target could be an external Address carried along and then finally used.
* External addresses are OK as long as nothing is done to the offset.
*
- * @param varnodeContext - context to use for any other infomation needed
+ * @param vContext - context to use for any other infomation needed
* @param instruction - instruction to place the reference on.
* @param opIndex - operand it should be placed on, or -1 if unknown
- * @param spaceID target space ID or -1 if only offset is known
+ * @param knownSpaceID target space ID or -1 if only offset is known
* @param wordOffset - target offset that is word addressing based
* @param refType - type of reference
* @param pcodeop - pcode op that caused the reference
- * @param monitor
+ * @param monitor - the task monitor
*/
public void makeReference(VarnodeContext vContext, Instruction instruction, int opIndex,
long knownSpaceID, long wordOffset, int size, RefType refType, int pcodeop,
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java
index 8be976f8d9..e5ce35c9ac 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java
@@ -565,9 +565,8 @@ public class VarnodeContext implements ProcessorContext {
}
/**
- * Check if a symbol is read_only.
+ * Check if the symbol at the address is read_only.
*
- * @param sym - symbol to check
* @param addr - address of the symbol
*
* @return true if the block is read_only, and there are no write references.
@@ -824,11 +823,13 @@ public class VarnodeContext implements ProcessorContext {
return lastSetAddr;
}
+ // TODO unused parameter bval
/**
* return the location that this varnode was last set
* This is a transient thing, so it should only be used as a particular flow is being processed...
*
- * @param reg
+ * @param rvar the register varnode
+ * @param bval this parameter is unused.
* @return address that the register was set.
*/
public Address getLastSetLocation(Varnode rvar, BigInteger bval) {
@@ -908,9 +909,10 @@ public class VarnodeContext implements ProcessorContext {
* get the value of a register as a varnode (value, space, size)
*
* @param reg register to get value for
- * @param address location for value
+ * @param fromAddr from address
+ * @param toAddr to address
* @param signed true if signed
- * @return null if the register has no value
+ * @return the register value or null
*/
public Varnode getRegisterVarnodeValue(Register reg, Address fromAddr, Address toAddr,
boolean signed) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java
index d733f71f32..42494c762f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/string/AbstractStringSearcher.java
@@ -91,8 +91,10 @@ public abstract class AbstractStringSearcher {
* Searches the given addressSet for strings.
*
* Note: The address set searched will be modified before searching in the following ways:
+ *
* - if the given set is null, it will be re-initialized to encompass all of program memory
* - the set will be further culled to only include loaded memory blocks, if specified
+ *
*
* @param addressSet the address set to search over; if null, will initialized to all memory
* @param callback the callback invoked when a string is found
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/ProjectTestUtils.java b/Ghidra/Features/Base/src/main/java/ghidra/test/ProjectTestUtils.java
index 8486713697..927da808a3 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/ProjectTestUtils.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/ProjectTestUtils.java
@@ -181,7 +181,8 @@ public class ProjectTestUtils {
* Create an empty program file within the specified project folder.
* @param proj active project.
* @param progName name of program and domain file to be created.
- * @param langType a specified language, or 0 if it does not matter.
+ * @param language a specified language, or 0 if it does not matter.
+ * @param compilerSpec the compiler spec
* @param folder domain folder within the specified project which the
* user has permission to write. If null, the root data folder will be used.
* @return new domain file.
@@ -242,7 +243,6 @@ public class ProjectTestUtils {
* @param project The project which with the tool is associated.
* @param tool The tool to be saved
* @return The tool template for the given tool.
- * @throws DuplicateNameException
*/
public static ToolTemplate saveTool(Project project, Tool tool) {
// save the tool to the project tool chest
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/ToyProgramBuilder.java b/Ghidra/Features/Base/src/main/java/ghidra/test/ToyProgramBuilder.java
index 6e867533d6..83e08c570e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/ToyProgramBuilder.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/ToyProgramBuilder.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -293,7 +292,7 @@ public class ToyProgramBuilder extends ProgramBuilder {
/**
* Add move immediate instruction (consumes 2-bytes)
- * @param addr instruction address
+ * @param offset instruction offset
* @param imm immediate byte value
* @throws MemoryAccessException
*/
@@ -395,7 +394,7 @@ public class ToyProgramBuilder extends ProgramBuilder {
/**
* Add call (consumes 2-bytes)
* @param addr instruction address
- * @param dest call destination address
+ * @param destAddr call destination address
* @throws MemoryAccessException
*/
public void addBytesCall(String addr, String destAddr) throws MemoryAccessException {
@@ -418,7 +417,7 @@ public class ToyProgramBuilder extends ProgramBuilder {
/**
* Add call w/ delayslot (consumes 4-bytes)
* @param addr instruction address
- * @param dest call destination address
+ * @param destAddr call destination address
* @throws MemoryAccessException
*/
public void addBytesCallWithDelaySlot(String addr, String destAddr)
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestCombinedTestResults.java b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestCombinedTestResults.java
index 964456b478..367a1fad8f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestCombinedTestResults.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestCombinedTestResults.java
@@ -166,7 +166,7 @@ public class PCodeTestCombinedTestResults {
/**
*
- * @param groupTestName .
+ * @param groupTestName {@code .}
*/
NamedTestColumn(String groupTestName) {
this.groupTestName = groupTestName;
@@ -183,14 +183,14 @@ public class PCodeTestCombinedTestResults {
}
/**
- * @return .
+ * @return {@code .}
*/
public String getGroupTestName() {
return groupTestName;
}
/**
- * @return
+ * @return {@code }
*/
public String getTestName() {
return testName;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestResults.java b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestResults.java
index 6db03c1b22..feaeb881a1 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestResults.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/PCodeTestResults.java
@@ -65,7 +65,7 @@ public class PCodeTestResults {
}
/**
- * @return collection of group/testNames in the form "."
+ * @return collection of group/testNames in the form {@code "."}
*/
public Collection getGroupTestNames() {
return results.keySet();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/ProcessorEmulatorTestAdapter.java b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/ProcessorEmulatorTestAdapter.java
index 7f7f5c49a5..a7dbe917dc 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/ProcessorEmulatorTestAdapter.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/test/processors/support/ProcessorEmulatorTestAdapter.java
@@ -72,7 +72,7 @@ import utility.application.ApplicationLayout;
* contained within the binary repository (e.g., ghidra.bin).
*
* Within the pcodetests directory all files and folders which start with the prefix
- * _pcodetest* will be processed. All files contained within a matching
+ * {@literal _pcodetest*} will be processed. All files contained within a matching
* subdirectory will be treated as related binaries and imported. Any *.gzf file will be
* imported but assumed to be pre-analyzed. Binary files to be imported and analyzed must
* utilize the *.out file extension.
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/StackFrameImpl.java b/Ghidra/Features/Base/src/main/java/ghidra/util/StackFrameImpl.java
index 51ead2222f..a5852f40c7 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/StackFrameImpl.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/StackFrameImpl.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,8 +36,8 @@ import java.lang.UnsupportedOperationException;
* saved registers).
*
* When a frame is created, the parameter stack start offset must be set up.
- * If the parameter start is >= 0, then the stack grows in the negative
- * direction. If the parameter start < 0, then the stack grows in the positive
+ * If the parameter start is >= 0, then the stack grows in the negative
+ * direction. If the parameter start < 0, then the stack grows in the positive
* direction. When a frame is created the parameter start offset must be
* specified. Later the parameter start offset can be changed, but it must
* remain positive/negative if the frame was created with a positive/negative
@@ -86,7 +85,7 @@ class StackFrameImpl implements StackFrame {
*
* Specified source is always ignored
* and the variable instance returned will never be a parameter.
- * @see ghidra.program.model.listing.StackFrame#createVariable(java.lang.String, int, ghidra.program.model.data.DataType, ghidra.program.model.symbol.SourceType)
+ * @see ghidra.program.model.listing.StackFrame#createVariable(String, int, DataType, SourceType)
*/
@Override
public Variable createVariable(String name, int offset, DataType dataType,
@@ -95,18 +94,11 @@ class StackFrameImpl implements StackFrame {
throw new UnsupportedOperationException();
}
- /**
- * @see ghidra.program.model.listing.StackFrame#getStackVariables()
- */
@Override
public Variable[] getStackVariables() {
return getAllVariables();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getLocals()
- */
@Override
public Variable[] getLocals() {
if (getParameterOffset() >= 0) {
@@ -115,20 +107,12 @@ class StackFrameImpl implements StackFrame {
return getPositiveVariables();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getParameters()
- */
@Override
public Variable[] getParameters() {
return (getParameterOffset() >= 0) ? getPositiveVariables() : getNegativeVariables();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getFrameSize()
- */
@Override
public int getFrameSize() {
int size = getLocalSize();
@@ -137,10 +121,6 @@ class StackFrameImpl implements StackFrame {
return size;
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getLocalSize()
- */
@Override
public int getLocalSize() {
if (localSize > 0) {
@@ -153,28 +133,16 @@ class StackFrameImpl implements StackFrame {
return getPositiveSize();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#growsNegative()
- */
@Override
public boolean growsNegative() {
return growsNegative;
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#setLocalSize(int)
- */
@Override
public void setLocalSize(int size) {
throw new UnsupportedOperationException();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getParameterSize()
- */
@Override
public int getParameterSize() {
if (growsNegative()) {
@@ -184,8 +152,10 @@ class StackFrameImpl implements StackFrame {
}
/**
+ * Gets the number of parameters in the stack frame regardless
+ * of the direction the stack grows in.
*
- * @see ghidra.program.model.listing.StackFrame#getParameterCount()
+ * @return the number of parameters in the stack frame.
*/
public int getParameterCount() {
if (growsNegative()) {
@@ -194,19 +164,11 @@ class StackFrameImpl implements StackFrame {
return getNegativeCount();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#clearVariable(int)
- */
@Override
public void clearVariable(int offset) {
throw new UnsupportedOperationException();
}
- /*
- * (non-Javadoc)
- * @see ghidra.program.model.listing.StackFrame#getParameterOffset()
- */
@Override
public int getParameterOffset() {
return paramStart;
@@ -227,31 +189,19 @@ class StackFrameImpl implements StackFrame {
// stackChanged();
// }
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getReturnAddressOffset()
- */
@Override
public int getReturnAddressOffset() {
return returnStart;
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#setReturnAddressOffset(int)
- */
@Override
public void setReturnAddressOffset(int offset) {
throw new UnsupportedOperationException();
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getVariableContaining(int)
- */
@Override
public Variable getVariableContaining(int offset) {
- Object key = new Integer(offset);
+ Object key = Integer.valueOf(offset);
int index = Collections.binarySearch(variables, key, StackVariableComparator.get());
if (index >= 0) {
return variables.get(index);
@@ -454,10 +404,6 @@ class StackFrameImpl implements StackFrame {
return length - index;
}
- /**
- *
- * @see ghidra.program.model.listing.StackFrame#getFunction()
- */
@Override
public Function getFunction() {
return function;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/ascii/MinLengthCharSequenceMatcher.java b/Ghidra/Features/Base/src/main/java/ghidra/util/ascii/MinLengthCharSequenceMatcher.java
index 5e36b65065..cfcd7a7509 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/ascii/MinLengthCharSequenceMatcher.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/ascii/MinLengthCharSequenceMatcher.java
@@ -71,7 +71,7 @@ public class MinLengthCharSequenceMatcher {
/**
* Indicates there are no more contiguous chars to add to this matcher. If a minimum or more
* number of included chars have been seen before this call, then a sequence is returned.
- * @return a Sequence if there was a sequence of chars >= the min length just before this call.
+ * @return a Sequence if there was a sequence of chars >= the min length just before this call.
*/
public boolean endSequence() {
lastSequence = null;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/bean/field/AnnotatedTextFieldElement.java b/Ghidra/Features/Base/src/main/java/ghidra/util/bean/field/AnnotatedTextFieldElement.java
index 0c8daf1af9..de6f2fd326 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/bean/field/AnnotatedTextFieldElement.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/bean/field/AnnotatedTextFieldElement.java
@@ -24,7 +24,7 @@ import ghidra.program.util.ProgramLocation;
/**
* A subclass of {@link FieldElement} that allows for mouse handling callbacks via the
- * {@link #handleMouseClicked(ProgramLocation, ServiceProvider)} method. This class
+ * {@link #handleMouseClicked(Navigatable, ServiceProvider)} method. This class
* is based upon {@link Annotation} objects, which are elements that perform actions when the
* use clicks an instance of this class in the display.
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/data/DataTypeParser.java b/Ghidra/Features/Base/src/main/java/ghidra/util/data/DataTypeParser.java
index 682d45e558..840c786a35 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/data/DataTypeParser.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/data/DataTypeParser.java
@@ -112,7 +112,7 @@ public class DataTypeParser {
* @param dataTypeManagerService data-type manager tool service, or null
* @param allowedTypes constrains which data-types may be parsed
*
- * @see #DataTypeParser(DataTypeManagerService, AllowedDataTypes)
+ * @see #DataTypeParser(DataTypeQueryService, AllowedDataTypes)
*/
public DataTypeParser(DataTypeManager sourceDataTypeManager,
DataTypeManager destinationDataTypeManager,
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/search/trie/ByteTrieIfc.java b/Ghidra/Features/Base/src/main/java/ghidra/util/search/trie/ByteTrieIfc.java
index 60b4d63492..57a4c69fee 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/search/trie/ByteTrieIfc.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/search/trie/ByteTrieIfc.java
@@ -79,7 +79,7 @@ public interface ByteTrieIfc {
* trie search algorithm.
* @param text the bytes to search
* @return a list of results (tuple of offset position, text found)
- * @throws CancelledException
+ * @throws CancelledException if the search is cancelled
*/
public abstract List> search(byte[] text, TaskMonitor monitor)
throws CancelledException;
@@ -87,11 +87,12 @@ public interface ByteTrieIfc {
/**
* Search an array of bytes using the Aho-Corasick multiple string
* trie search algorithm.
- * @param monitor
- * @param text the bytes to search
+ * @param memory the memory to search in
+ * @param view the AddressSetView to restrict the memory search to.
+ * @param monitor the task monitor
* @return a list of results (tuple of offset position, text found)
- * @throws MemoryAccessException
- * @throws CancelledException
+ * @throws MemoryAccessException if an error occurs reading the memory
+ * @throws CancelledException if the search is cancelled
*/
public abstract List> search(Memory memory, AddressSetView view,
TaskMonitor monitor) throws MemoryAccessException, CancelledException;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/state/ContextState.java b/Ghidra/Features/Base/src/main/java/ghidra/util/state/ContextState.java
index e609d114fe..2bab002944 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/state/ContextState.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/state/ContextState.java
@@ -70,9 +70,8 @@ public class ContextState {
/**
* Constructs an empty state.
- * @param pcodeEntry instruction identifies the instruction entry point for this context state.
- * A pcodeIndex of 0 is assumed. Initial state utilizes the program's stored context.
- * @param program
+ * @param entryPt the entry point for the context state
+ * @param program the program
*/
public ContextState(Address entryPt, Program program) {
this(entryPt, program.getProgramContext(), program);
@@ -80,10 +79,9 @@ public class ContextState {
/**
* Constructs an empty state.
- * @param pcodeEntry instruction identifies the instruction entry point for this context state.
- * A pcodeIndex of 0 is assumed.
+ * @param entryPt the entry point for the context state
* @param programCtx initial program context or null
- * @param program
+ * @param program the program
*/
public ContextState(Address entryPt, ProgramContext programCtx, Program program) {
this.program = program;
@@ -100,8 +98,7 @@ public class ContextState {
/**
* Derive a new context state from an initial state
- * @param instructionAddr instruction identifies the instruction entry point for this context state.
- * @param pcodeIndex pcode identifies the pcode entry point for this context state.
+ * @param pcodeEntry the pcode entry sequence number
* @param previousState previous context state flowing into the specified pcode location
*/
public ContextState(SequenceNumber pcodeEntry, ContextState previousState) {
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/state/ResultsState.java b/Ghidra/Features/Base/src/main/java/ghidra/util/state/ResultsState.java
index 257d4855b8..ae3fc3064e 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/state/ResultsState.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/state/ResultsState.java
@@ -110,10 +110,10 @@ public class ResultsState {
/**
* Constructor from a function entry point. Program context is used to establish the entry context state.
* Analysis is performed during construction.
- * @param entryAddr function entry point
+ * @param entryPt function entry point
* @param analyzer function analysis call-back handler
* @param program program containing function
- * @param maintainInstructionResults
+ * @param maintainInstructionResults true to maintain the instruction results
* @param monitor task monitor
* @throws CancelledException
*/
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 e77df537bb..1a985ad94c 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
@@ -33,7 +33,7 @@ import resources.Icons;
/**
*
- * An action used to trigger navigation callback on instances of {@link #JTable}. Users can
+ * 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.
*
* Subclasses need to implement {@link #navigate()}, which will be called when a navigation is
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/AddressArrayTableModel.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/AddressArrayTableModel.java
index 7c730cbb8a..a9eaae08be 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/AddressArrayTableModel.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/AddressArrayTableModel.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,7 +28,8 @@ import ghidra.util.task.TaskMonitor;
*
* If you need to compute the address array, then you should
* extend {@link AddressPreviewTableModel} and override the
- * {@link AddressPreviewTableModel#doLoad(Accumulator
accumulator, TaskMonitor monitor)}
+ * {@link AddressPreviewTableModel#doLoad(Accumulator, TaskMonitor)
+ * doLoad(Accumulator<Address> accumulator, TaskMonitor monitor)}
* method which will be called in a dedicated thread.
*
* Alternatively, you can create an instance of the {@link CustomLoadingAddressTableModel},
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/table/CompositeGhidraTableCellRenderer.java b/Ghidra/Features/Base/src/main/java/ghidra/util/table/CompositeGhidraTableCellRenderer.java
index 4eb91a5dcd..a402312469 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/table/CompositeGhidraTableCellRenderer.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/table/CompositeGhidraTableCellRenderer.java
@@ -30,7 +30,7 @@ import docking.widgets.table.GTableCellRenderingData;
* Why: Sometimes the need arises to be able to use the default table rendering while adding
* additional rendering (e.g., to be able to add row coloring).
* How: Create a cell renderer that extends this class and install that into your table. Then,
- * override {@link #getTableCellRendererComponent(JTable, Object, Settings, boolean, boolean, int, int)}
+ * override {@link #getTableCellRendererComponent(JTable, Object, boolean, boolean, int, int)}
* to call this class' implementation. Finally, add desired decoration.
*
*/
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java b/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java
index 7462fb6e34..a45a0c1af6 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/util/xml/XmlTestHelper.java
@@ -71,10 +71,11 @@ public class XmlTestHelper {
/**
* Read an XML file as a resource.
*
- * @param package
+ * @param pkg
* where resource resides
* @param name
* name of the resource that is in the given package
+ * @throws IOException thrown if there was a problem accessing the xml resource.
*/
public void loadXmlResource(Package pkg, String name) throws IOException {
String pkgName = pkg.getName();
@@ -200,12 +201,13 @@ public class XmlTestHelper {
}
/**
- * @param string
- * @return
+ * @param programName the program name
+ * @return the program
* @throws VersionException
* @throws InvalidNameException
* @throws DuplicateNameException
* @throws CancelledException
+ * @throws FileNotFoundException if the file is not found
*/
public Program loadResourceProgram(String programName) throws IOException, CancelledException,
DuplicateNameException, InvalidNameException, VersionException {
diff --git a/Ghidra/Features/Base/src/main/java/help/screenshot/TutorialScreenShotGenerator.java b/Ghidra/Features/Base/src/main/java/help/screenshot/TutorialScreenShotGenerator.java
index 5bb5dce955..27da6c9fa0 100644
--- a/Ghidra/Features/Base/src/main/java/help/screenshot/TutorialScreenShotGenerator.java
+++ b/Ghidra/Features/Base/src/main/java/help/screenshot/TutorialScreenShotGenerator.java
@@ -29,8 +29,7 @@ public class TutorialScreenShotGenerator extends AbstractScreenShotGenerator {
}
/**
- * @deprecated use instead {@link #showImage(String)}, which will show a comparison of the old
- * and new images
+ * @deprecated
*
* NOTE: Please do not remove this until we have decided how to create a showImage() method
* that is compatible with screenshots NOT in Help (ahem, Tutorial!!!).
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/ClangXML.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/ClangXML.java
index a84f8c0039..e8c6dce897 100644
--- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/ClangXML.java
+++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/ClangXML.java
@@ -27,7 +27,7 @@ import ghidra.xml.*;
*
*
* To change the template for this generated type comment go to
- * Window>Preferences>Java>Code Generation>Code and Comments
+ *{@literal Window>Preferences>Java>Code Generation>Code and Comments}
*/
public abstract class ClangXML { // Placeholder for CLANG XML identifiers
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompInterface.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompInterface.java
index 40a14b8e0b..f5c2fb9d59 100644
--- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompInterface.java
+++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompInterface.java
@@ -124,7 +124,7 @@ public class DecompInterface {
/**
* Turn on debugging dump for the next decompiled
* function
- * @param filename in which to save dump
+ * @param debugfile the file to enable debug dubp
*/
public synchronized void enableDebug(File debugfile) {
debug = new DecompileDebug(debugfile);
@@ -685,7 +685,6 @@ public class DecompInterface {
* will be returned and a timeout error set.
* @param monitor optional task monitor which may be used to cancel decompile
* @return decompiled function text
- * @throws CancelledException operation was cancelled via monitor
*/
public synchronized DecompileResults decompileFunction(Function func, int timeoutSecs,
TaskMonitor monitor) {
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompileOptions.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompileOptions.java
index a8e86814cf..1e51b4ace3 100644
--- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompileOptions.java
+++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/DecompileOptions.java
@@ -452,7 +452,7 @@ public class DecompileOptions { //
* @param ownerPlugin the plugin to which the options should be registered
* @param opt the options object to register with
* @param program the program
- * @param hlep
+ * @param help the help
*/
public void registerOptions(Plugin ownerPlugin, ToolOptions opt, Program program,
HelpLocation help) {
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerController.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerController.java
index 97c9c2cfce..b84d9290f9 100644
--- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerController.java
+++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerController.java
@@ -88,7 +88,7 @@ public class DecompilerController {
* Shows the function containing the given location in the decompilerPanel. Also, positions the
* decompilerPanel's cursor to the closest equivalent position. If the decompilerPanel is
* already displaying the function, then only the cursor is repositioned. To force a
- * re-decompile use {@link #refreshDisplay(Program, ProgramLocation)}.
+ * re-decompile use {@link #refreshDisplay(Program, ProgramLocation, File)}.
*
* @param program the program for the given location
* @param location the location containing the function to be displayed and the location in
diff --git a/Ghidra/Features/GhidraServer/src/main/java/db/buffers/RemoteBufferFileImpl.java b/Ghidra/Features/GhidraServer/src/main/java/db/buffers/RemoteBufferFileImpl.java
index 9ddaab6ba0..387275d32f 100644
--- a/Ghidra/Features/GhidraServer/src/main/java/db/buffers/RemoteBufferFileImpl.java
+++ b/Ghidra/Features/GhidraServer/src/main/java/db/buffers/RemoteBufferFileImpl.java
@@ -175,7 +175,7 @@ public class RemoteBufferFileImpl extends UnicastRemoteObject
* Dispose and unexport all RemoteBufferFileImpl instances associated with the
* specified owner.
* @param owner
- * @returns true if one or more buffer files were disposed.
+ * @return true if one or more buffer files were disposed.
*/
public static synchronized boolean dispose(Object owner) {
boolean found = false;
diff --git a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/Repository.java b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/Repository.java
index 66b33f68fb..0930194376 100644
--- a/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/Repository.java
+++ b/Ghidra/Features/GhidraServer/src/main/java/ghidra/server/Repository.java
@@ -418,7 +418,7 @@ public class Repository implements FileSystemListener, RepositoryLogger {
}
/**
- * @returns true if anonymous access is allowed for this repository
+ * @return true if anonymous access is allowed for this repository
*/
public boolean anonymousAccessAllowed() {
return anonymousAccessAllowed;
diff --git a/Ghidra/Features/Python/src/main/java/ghidra/python/GhidraPythonInterpreter.java b/Ghidra/Features/Python/src/main/java/ghidra/python/GhidraPythonInterpreter.java
index 8c3deb4672..4b8b98d228 100644
--- a/Ghidra/Features/Python/src/main/java/ghidra/python/GhidraPythonInterpreter.java
+++ b/Ghidra/Features/Python/src/main/java/ghidra/python/GhidraPythonInterpreter.java
@@ -472,7 +472,7 @@ public class GhidraPythonInterpreter extends InteractiveInterpreter {
}
/**
- * Returns a Map of property->string_substitution pairs.
+ * Returns a Map of property->string_substitution pairs.
*
* @param cmd current command
* @param includeBuiltins True if we should include python built-ins; otherwise, false.
diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTProgramCorrelator.java
index 036adb8677..a27829c8c7 100644
--- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTProgramCorrelator.java
+++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/main/VTProgramCorrelator.java
@@ -29,7 +29,7 @@ public interface VTProgramCorrelator {
* @param session An existing manager that may contain previous results that may
* influence this correlation.
* @param monitor a task monitor for reporting progress during the correlation.
- * @returns the match set created by this correlator used to store results.
+ * @return the match set created by this correlator used to store results.
*
* @throws CancelledException if the user cancels the correlation via the task monitor.
*/
diff --git a/Ghidra/Framework/DB/src/main/java/db/BinaryCodedField.java b/Ghidra/Framework/DB/src/main/java/db/BinaryCodedField.java
index b48925f4aa..ae03cf7851 100644
--- a/Ghidra/Framework/DB/src/main/java/db/BinaryCodedField.java
+++ b/Ghidra/Framework/DB/src/main/java/db/BinaryCodedField.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -91,7 +90,7 @@ public class BinaryCodedField extends BinaryField {
/**
* Construct a coded field from an existing binary field.
- * @param binary field
+ * @param binField the binary field
*/
public BinaryCodedField(BinaryField binField) {
data = binField.getBinaryData();
@@ -99,7 +98,7 @@ public class BinaryCodedField extends BinaryField {
/**
* Construct a coded field from a double value.
- * @param value
+ * @param value the double value
*/
public BinaryCodedField(double value) {
BinaryDataBuffer buffer = new BinaryDataBuffer(9);
@@ -110,7 +109,7 @@ public class BinaryCodedField extends BinaryField {
/**
* Construct a coded field from a float value.
- * @param value
+ * @param value the float value
*/
public BinaryCodedField(float value) {
BinaryDataBuffer buffer = new BinaryDataBuffer(5);
diff --git a/Ghidra/Framework/DB/src/main/java/db/ChainedBuffer.java b/Ghidra/Framework/DB/src/main/java/db/ChainedBuffer.java
index 9e69467d86..19d16b3d5e 100644
--- a/Ghidra/Framework/DB/src/main/java/db/ChainedBuffer.java
+++ b/Ghidra/Framework/DB/src/main/java/db/ChainedBuffer.java
@@ -115,7 +115,7 @@ public class ChainedBuffer implements Buffer {
* Construct a new chained buffer with optional obfuscation and uninitialized data source.
* This method may only be invoked while a database transaction
* is in progress.
- * @param size buffer size (0 < size <= 0x7fffffff)
+ * @param size {@literal buffer size (0 < size <= 0x7fffffff)}
* @param enableObfuscation true to enable xor-ing of stored data to facilitate data obfuscation.
* @param uninitializedDataSource optional data source for uninitialized data. This should be a
* read-only buffer which will always be used when re-instantiating the same stored ChainedBuffer.
@@ -168,7 +168,7 @@ public class ChainedBuffer implements Buffer {
* Construct a new chained buffer with optional obfuscation.
* This method may only be invoked while a database transaction
* is in progress.
- * @param size buffer size (0 < size <= 0x7fffffff)
+ * @param size {@literal buffer size (0 < size <= 0x7fffffff)}
* @param enableObfuscation true to enable xor-ing of stored data to facilitate data obfuscation.
* @param bufferMgr database buffer manager
* @throws IOException
@@ -181,7 +181,7 @@ public class ChainedBuffer implements Buffer {
/**
* Construct a new chained buffer.
* This method may only be invoked while a database transaction is in progress.
- * @param size buffer size (0 < size <= 0x7fffffff)
+ * @param size {@literal buffer size (0 < size <= 0x7fffffff)}
* @param bufferMgr database buffer manager
* @throws IOException
*/
diff --git a/Ghidra/Framework/DB/src/main/java/db/DBBuffer.java b/Ghidra/Framework/DB/src/main/java/db/DBBuffer.java
index b0ee1552c5..a16da3e6e8 100644
--- a/Ghidra/Framework/DB/src/main/java/db/DBBuffer.java
+++ b/Ghidra/Framework/DB/src/main/java/db/DBBuffer.java
@@ -106,7 +106,7 @@ public class DBBuffer {
* Append the contents of the specified dbBuf onto the end of this buffer.
* The size of this buffer increases by the size of dbBuf. When the operation
* is complete, dbBuf object is no longer valid and must not be used.
- * @param dbBuf the buffer to be appended to this buffer.
+ * @param buffer the buffer to be appended to this buffer.
* @throws IOException thrown if an IO error occurs
*/
public void append(DBBuffer buffer) throws IOException {
@@ -168,11 +168,9 @@ public class DBBuffer {
* at the specified offset. The number of bytes stored is specified by the
* length specified.
* @param offset byte offset from start of buffer.
- * @param data the byte data to be stored.
+ * @param bytes the byte data to be stored.
* @param dataOffset the starting offset into the data.
* @param length the number of bytes to be stored.
- * @return the next available offset into the buffer, or -1 if the buffer is
- * full.
* @throws ArrayIndexOutOfBoundsException if an invalid offset is provided
* or the end of buffer was encountered while storing the data.
* @throws IOException is thrown if an error occurs while accessing the
@@ -192,8 +190,6 @@ public class DBBuffer {
* array.
* @param offset byte offset from start of buffer.
* @param bytes the byte data to be stored.
- * @return the next available offset into the buffer, or -1 if the buffer is
- * full.
* @throws ArrayIndexOutOfBoundsException if an invalid offset is provided
* or the end of buffer was encountered while storing the data.
* @throws IOException is thrown if an error occurs while accessing the
@@ -210,8 +206,6 @@ public class DBBuffer {
* Put the 8-bit byte value into the buffer at the specified offset.
* @param offset byte offset from start of buffer.
* @param b the byte value to be stored.
- * @return the next available offset into the buffer, or -1 if the buffer is
- * full.
* @throws ArrayIndexOutOfBoundsException if an invalid offset is provided.
* @throws IOException is thrown if an error occurs while accessing the
* underlying storage.
@@ -226,7 +220,6 @@ public class DBBuffer {
/**
* Get the byte data located at the specified offset.
* @param offset byte offset from start of buffer.
- * @return the byte array.
* @throws ArrayIndexOutOfBoundsException is thrown if an invalid offset is
* specified or the end of the buffer was encountered while reading the
* data.
diff --git a/Ghidra/Framework/DB/src/main/java/db/DBHandle.java b/Ghidra/Framework/DB/src/main/java/db/DBHandle.java
index c7453a9303..a99a3a43ac 100644
--- a/Ghidra/Framework/DB/src/main/java/db/DBHandle.java
+++ b/Ghidra/Framework/DB/src/main/java/db/DBHandle.java
@@ -670,7 +670,6 @@ public class DBHandle {
* @param newDatabaseId database ID to be forced for new database or null to generate
* new database ID
* @param monitor progress monitor
- * @param associateWithNewFile if true this handle will be associated with the new file
* @throws IOException if IO error occurs
* @throws CancelledException if monitor cancels operation
*/
@@ -915,10 +914,11 @@ public class DBHandle {
}
/**
- *
- * @param table
- * @param id
- * @throws DuplicateNameException
+ * Changes the name of an existing table.
+ * @param oldName the old name of the table
+ * @param newName the new name of the table
+ * @throws DuplicateNameException if a table with the new name already exists
+ * @return true if the name was changed successfully
*/
public synchronized boolean setTableName(String oldName, String newName)
throws DuplicateNameException {
diff --git a/Ghidra/Framework/DB/src/main/java/db/DBLongIterator.java b/Ghidra/Framework/DB/src/main/java/db/DBLongIterator.java
index 69b19c4346..a52d67b1d0 100644
--- a/Ghidra/Framework/DB/src/main/java/db/DBLongIterator.java
+++ b/Ghidra/Framework/DB/src/main/java/db/DBLongIterator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -39,14 +38,14 @@ public interface DBLongIterator {
/**
* Return the next long value.
* @throws IOException thrown if an IO error occurs
- * @throws NoSuchElementException if the next value is not available.
+ * @throws java.util.NoSuchElementException if the next value is not available.
*/
public long next() throws IOException;
/**
* Return the previous long value.
* @throws IOException thrown if an IO error occurs
- * @throws NoSuchElementException if the previous value is not available.
+ * @throws java.util.NoSuchElementException if the previous value is not available.
*/
public long previous() throws IOException;
diff --git a/Ghidra/Framework/DB/src/main/java/db/Record.java b/Ghidra/Framework/DB/src/main/java/db/Record.java
index ac03950a29..f757ac5e0f 100644
--- a/Ghidra/Framework/DB/src/main/java/db/Record.java
+++ b/Ghidra/Framework/DB/src/main/java/db/Record.java
@@ -347,7 +347,7 @@ public class Record implements Comparable {
/**
* Set the binary data array for the specified field.
* @param colIndex field index
- * @param value field value
+ * @param bytes field value
* @throws IllegalFieldAccessException if field does support binary data access
*/
public void setBinaryData(int colIndex, byte[] bytes) {
@@ -369,7 +369,7 @@ public class Record implements Comparable {
/**
* Set the string value for the specified field.
* @param colIndex field index
- * @param value field value
+ * @param str field value
* @throws IllegalFieldAccessException if field does support string data access
*/
public void setString(int colIndex, String str) {
diff --git a/Ghidra/Framework/DB/src/main/java/db/Table.java b/Ghidra/Framework/DB/src/main/java/db/Table.java
index 91ab3f54b7..2c125cd2f0 100644
--- a/Ghidra/Framework/DB/src/main/java/db/Table.java
+++ b/Ghidra/Framework/DB/src/main/java/db/Table.java
@@ -1497,11 +1497,10 @@ public class Table {
* @param columnIndex schema column to sort on.
* @param startValue the starting and minimum value of the secondary index field.
* @param endValue the ending and maximum value of the secondary index field.
- * @param primaryKey the primary key associated with the startField.
* @param atStart if true, position the iterator before the start value.
* Otherwise, position the iterator after the end value.
*
- * @return RecordIterator record iterator.
+ * @return record iterator.
* @throws IOException if a secondary index does not exist for the specified
* column, or the wrong field type was specified, or an I/O error occurs.
*/
@@ -1787,7 +1786,7 @@ public class Table {
* Iterate over the records in ascending sorted order. Sorting occurs on the primary key value
* starting at the specified startKey.
* @param minKey the minimum primary key.
- * @param endKey the maximum primary key.
+ * @param maxKey the maximum primary key.
* @param startKey the initial iterator position.
* @return record iterator
* @throws IOException if an I/O error occurs.
@@ -1823,7 +1822,7 @@ public class Table {
* Iterate over the records in ascending sorted order. Sorting occurs on the primary key value
* starting at the specified startKey.
* @param minKey the minimum primary key, may be null.
- * @param endKey the maximum primary key, may be null.
+ * @param maxKey the maximum primary key, may be null.
* @param startKey the initial iterator position, if null minKey is also start.
* @return record iterator
* @throws IOException if an I/O error occurs.
@@ -1872,7 +1871,7 @@ public class Table {
* Iterate over the long primary keys in ascending sorted order
* starting at the specified startKey.
* @param minKey the minimum primary key.
- * @param endKey the maximum primary key.
+ * @param maxKey the maximum primary key.
* @param startKey the initial iterator position.
* @return long key iterator
* @throws IOException if an I/O error occurs.
@@ -1888,7 +1887,6 @@ public class Table {
/**
* Iterate over all primary keys in ascending sorted order.
- * @param startKey the first primary key, may be null.
* @return Field type key iterator
* @throws IOException if an I/O error occurs.
*/
diff --git a/Ghidra/Framework/DB/src/main/java/db/VarKeyInteriorNode.java b/Ghidra/Framework/DB/src/main/java/db/VarKeyInteriorNode.java
index 6dd223f6c8..d56d279136 100644
--- a/Ghidra/Framework/DB/src/main/java/db/VarKeyInteriorNode.java
+++ b/Ghidra/Framework/DB/src/main/java/db/VarKeyInteriorNode.java
@@ -243,7 +243,7 @@ class VarKeyInteriorNode extends VarKeyNode {
* key index which corresponds to the specified key offset. This facilitates
* finding the key which utilizes the buffer storage at the specified
* offset.
- * @returns key index.
+ * @return key index.
*/
private int getOffsetIndex(int offset) {
diff --git a/Ghidra/Framework/DB/src/main/java/db/VarKeyRecordNode.java b/Ghidra/Framework/DB/src/main/java/db/VarKeyRecordNode.java
index c0de9152bb..e8da06aaac 100644
--- a/Ghidra/Framework/DB/src/main/java/db/VarKeyRecordNode.java
+++ b/Ghidra/Framework/DB/src/main/java/db/VarKeyRecordNode.java
@@ -630,7 +630,7 @@ class VarKeyRecordNode extends VarKeyNode {
/**
* Find the index which represents the halfway point within the record data.
- * @returns key index.
+ * @return key index.
*/
private int getSplitIndex() {
diff --git a/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java b/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java
index 49a095ed18..946a149f6b 100644
--- a/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java
+++ b/Ghidra/Framework/DB/src/main/java/db/VarRecNode.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -233,7 +232,7 @@ class VarRecNode extends LongKeyRecordNode {
/**
* Find the index which represents the halfway point within the record data.
- * @returns key index.
+ * @return key index.
*/
private int getSplitIndex() {
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/BufferFile.java b/Ghidra/Framework/DB/src/main/java/db/buffers/BufferFile.java
index 481346bd3d..60017ed585 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/BufferFile.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/BufferFile.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,7 +39,7 @@ public interface BufferFile {
* If file is open read-write, the modified contents are flushed
* and the file re-opened as read-only. This is also used to commit
* a new version if the file had been modified for update.
- * @returns true if successfully transitioned from read-write to read-only
+ * @return true if successfully transitioned from read-write to read-only
* @throws IOException if an I/O error occurs
*/
boolean setReadOnly() throws IOException;
@@ -120,7 +119,7 @@ public interface BufferFile {
/**
* Delete this buffer file if writable. Once deleted,
* this object is immediately disposed and may no longer be used.
- * @returns true if deleted, false if the file is read-only
+ * @return true if deleted, false if the file is read-only
* @throws IOException if an I/O error occurs.
*/
boolean delete() throws IOException;
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/BufferMgr.java b/Ghidra/Framework/DB/src/main/java/db/buffers/BufferMgr.java
index 77d4aa0af7..a157bbe596 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/BufferMgr.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/BufferMgr.java
@@ -1439,7 +1439,7 @@ public class BufferMgr {
* @param changeSet an optional database-backed change set which reflects changes
* made since the last version.
* @param monitor task monitor
- * @returns true if snapshot successful, false if
+ * @return true if snapshot successful, false if
*/
public boolean takeRecoverySnapshot(DBChangeSet changeSet, TaskMonitor monitor)
throws IOException, CancelledException {
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/DataBuffer.java b/Ghidra/Framework/DB/src/main/java/db/buffers/DataBuffer.java
index 6e4f782a77..7497b69c1f 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/DataBuffer.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/DataBuffer.java
@@ -88,7 +88,6 @@ public class DataBuffer implements Buffer, Externalizable {
/**
* Get the storage array associated with this buffer.
- * @return byte storage array.
*/
protected void setData(byte[] data) {
this.data = data;
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/LocalManagedBufferFile.java b/Ghidra/Framework/DB/src/main/java/db/buffers/LocalManagedBufferFile.java
index b7e056bd66..dbdba45143 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/LocalManagedBufferFile.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/LocalManagedBufferFile.java
@@ -533,15 +533,13 @@ public class LocalManagedBufferFile extends LocalBufferFile implements ManagedBu
}
/**
- * Create a new buffer file version (used for checkin)
- * @param srcFile must be a revision of destFile since change data from
- * srcFile will control the actual modifications made to destFile.
+ * Create a new buffer file version (used for check-in)
* @param destFile must be an versioned file representing an earlier version
* of srcFile.
- * @param fileComment
- * @param monitor
- * @throws CancelledException
- * @throws IOException
+ * @param fileComment a comment for the new version.
+ * @param monitor the current monitor.
+ * @throws CancelledException if the operation is canceled.
+ * @throws IOException if the file is in an unexpected state.
*/
public void createNewVersion(ManagedBufferFile destFile, String fileComment,
TaskMonitor monitor) throws CancelledException, IOException {
@@ -568,13 +566,13 @@ public class LocalManagedBufferFile extends LocalBufferFile implements ManagedBu
changeDataFile = getNextChangeDataFile(true);
if (changeDataFile == null) {
- throw new IOException("Unexpected state for checkin file");
+ throw new IOException("Unexpected state for check-in file");
}
BufferFile nextChangeDataFile = getNextChangeDataFile(false);
if (nextChangeDataFile != null) {
nextChangeDataFile.dispose();
- throw new IOException("Unexpected state for checkin file");
+ throw new IOException("Unexpected state for check-in file");
}
// Create new version
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFile.java b/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFile.java
index 2abe97e66a..9bddf954cf 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFile.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFile.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -83,7 +82,7 @@ public interface ManagedBufferFile extends BufferFile {
* Returns true if a save file is provided for creating a new
* version of this buffer file.
* @throws IOException if an I/O error occurs
- * @see BufferFile.getSaveFile
+ * @see #getSaveFile()
*/
boolean canSave() throws IOException;
diff --git a/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFileAdapter.java b/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFileAdapter.java
index 4660e9f467..3d36a6738c 100644
--- a/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFileAdapter.java
+++ b/Ghidra/Framework/DB/src/main/java/db/buffers/ManagedBufferFileAdapter.java
@@ -28,7 +28,7 @@ public class ManagedBufferFileAdapter extends BufferFileAdapter implements Manag
/**
* Constructor.
- * @param remoteBufferFile remote buffer file handle
+ * @param remoteManagedBufferFile remote buffer file handle
*/
public ManagedBufferFileAdapter(ManagedBufferFileHandle remoteManagedBufferFile) {
super(remoteManagedBufferFile);
diff --git a/Ghidra/Framework/Demangler/src/main/java/util/demangler/CharacterIterator.java b/Ghidra/Framework/Demangler/src/main/java/util/demangler/CharacterIterator.java
index 27a4131c86..3a8fd0fcef 100644
--- a/Ghidra/Framework/Demangler/src/main/java/util/demangler/CharacterIterator.java
+++ b/Ghidra/Framework/Demangler/src/main/java/util/demangler/CharacterIterator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -74,7 +73,6 @@ public class CharacterIterator {
/**
* Sets the position to the specified position in the text.
* @param index the position within the text.
- * @return the character at the specified position
* @throws IllegalArgumentException if index is not in range from 0 to string.length()-1
*/
public void setIndex(int index) {
diff --git a/Ghidra/Framework/Demangler/src/main/java/util/demangler/GenericDemangledObject.java b/Ghidra/Framework/Demangler/src/main/java/util/demangler/GenericDemangledObject.java
index f31c6cf6ef..54c8fab421 100644
--- a/Ghidra/Framework/Demangler/src/main/java/util/demangler/GenericDemangledObject.java
+++ b/Ghidra/Framework/Demangler/src/main/java/util/demangler/GenericDemangledObject.java
@@ -224,11 +224,11 @@ public abstract class GenericDemangledObject {
/**
* Returns a complete signature for the demangled symbol.
- * For example:
- * "unsigned long foo"
+ *
For example:
+ * {@code "unsigned long foo"
* "unsigned char * ClassA::getFoo(float, short *)"
- * "void * getBar(int **, MyStruct &)"
- * Note: based on the underlying mangling scheme, the
+ * "void * getBar(int **, MyStruct &)"}
+ *
Note: based on the underlying mangling scheme, the
* return type may or may not be specified in the signature.
* @param format true if signature should be pretty printed
* @return a complete signature for the demangled symbol
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
index 415b74836b..820c198ad2 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java
@@ -532,7 +532,7 @@ public abstract class ComponentProvider implements HelpDescriptor, ActionContext
* text returned from {@link #getTitle()} will be used by default.
*
* @return the optionally set text to display in the tab for a component provider.
- * @set {@link #setTabText(String)}
+ * @see #setTabText(String)
*/
public String getTabText() {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DisabledComponentLayerFactory.java b/Ghidra/Framework/Docking/src/main/java/docking/DisabledComponentLayerFactory.java
index a89e4d4ae6..a85bd9234c 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/DisabledComponentLayerFactory.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/DisabledComponentLayerFactory.java
@@ -22,7 +22,7 @@ import javax.swing.*;
import javax.swing.plaf.LayerUI;
/**
- * A factory to create JLayer instances to provide the L&F and functionality of a
+ * A factory to create JLayer instances to provide the L&F and functionality of a
* disabled panel -- the component assumes a disabled color, and selection via mouse and
* keyboard is prevented. As this is simply a layer in the UI stack, previous states of
* components is maintained and unmodified.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
index ea54da70d4..dfbfdfcfb3 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/DockingUtils.java
@@ -42,7 +42,7 @@ import ghidra.util.HTMLUtilities;
import resources.ResourceManager;
/**
- * Notes about how to use HTML safely:
+ * Notes about how to use HTML safely:
* Java's built-in HTML rendering in UI components is very useful, but can also introduce security
* issues when a hostile actor is providing the text strings that are being rendered.
*
@@ -77,9 +77,9 @@ import resources.ResourceManager;
* value at the start of the string, but instead put a quote or some other delimiter to prevent
* html mode).
*
- *
Recommended Ghidra UI Components:
+ * Recommended Ghidra UI Components:
*
- *
+ *
* | Native Component | Recommended Component |
|---|
* | {@link JLabel} | {@link GLabel}
{@link GDLabel}
{@link GHtmlLabel}
{@link GDHtmlLabel}
{@link GIconLabel} |
* | {@link JCheckBox} | {@link GCheckBox}
{@link GHtmlCheckBox} |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
index 7b07df4319..7be392989b 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/KeyBindingOverrideKeyEventDispatcher.java
@@ -87,7 +87,7 @@ public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher
* Reserved keybinding actions
* KeyListeners on the focused Component
* InputMap and ActionMap actions for the Component
- * Ghidra tool-level actions
+ * Ghidra tool-level actions
* InputMap and ActionMap actions for the Component's parent, and so on up the
* Swing hierarchy
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/WindowPosition.java b/Ghidra/Framework/Docking/src/main/java/docking/WindowPosition.java
index 7655989417..938b258d0c 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/WindowPosition.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/WindowPosition.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -28,7 +27,7 @@ public enum WindowPosition {
* be placed into their own window.
*
* This position is ignored when used with components that share the same group (a.k.a.,
- * when used as an intragroup positioning item).
+ * when used as an intragroup positioning item).
*/
WINDOW,
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java b/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java
index 84c09e7ef0..3752314dbe 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java
@@ -92,6 +92,10 @@ public abstract class DockingAction implements DockingActionIf {
supportsKeyBindings ? KeyBindingType.INDIVIDUAL : KeyBindingType.UNSUPPORTED;
}
+ protected KeyBindingType getPreferredKeyBindingType() {
+ return KeyBindingType.INDIVIDUAL;
+ }
+
@Override
public abstract void actionPerformed(ActionContext context);
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 b7b48bfee9..0ccf9c1202 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/actions/KeyBindingUtils.java
@@ -633,7 +633,7 @@ public class KeyBindingUtils {
/**
* Convert the toString() form of the keyStroke.
- *
In Java 1.4.2 & earlier, Ctrl-M is returned as "keyCode CtrlM-P"
+ *
In Java 1.4.2 and earlier, Ctrl-M is returned as "keyCode CtrlM-P"
* and we want it to look like: "Ctrl-M".
*
In Java 1.5.0, Ctrl-M is returned as "ctrl pressed M"
* and we want it to look like: "Ctrl-M".
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/dnd/Draggable.java b/Ghidra/Framework/Docking/src/main/java/docking/dnd/Draggable.java
index 7fe61f99b3..8195bcf7f4 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/dnd/Draggable.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/dnd/Draggable.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -62,7 +61,7 @@ public interface Draggable {
*
DnDConstants.ACTION_MOVE
* DnDConstants.ACTION_COPY
* DnDConstants.ACTION_COPY_OR_MOVE
- *
+ *
*
* @return the drag actions
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/dnd/GenericDataFlavor.java b/Ghidra/Framework/Docking/src/main/java/docking/dnd/GenericDataFlavor.java
index e094f6c460..4366f66bcf 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/dnd/GenericDataFlavor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/dnd/GenericDataFlavor.java
@@ -59,9 +59,9 @@ public class GenericDataFlavor extends DataFlavor {
/**
* Construct a GenericDataFlavor that represents a MimeType
* If the mimeType is
- * "application/x-java-serialized-object; class=",
+ * {@code "application/x-java-serialized-object; class=",
* the result is the same as calling
- * new GenericDataFlavor(Class:forName()
+ * new GenericDataFlavor(Class:forName()}
* @param mimeType the string used to identify the MIME type for
* this flavor
* @param humanPresentableName the human-readable string used to
@@ -77,9 +77,9 @@ public class GenericDataFlavor extends DataFlavor {
/**
* Construct a GenericDataFlavor that represents a MimeType
* If the mimeType is
- * "application/x-java-serialized-object; class=",
+ * {@code "application/x-java-serialized-object; class=",
* the result is the same as calling
- * new GenericDataFlavor(Class:forName().
+ * new GenericDataFlavor(Class:forName().}
*
* @param mimeType the string used to identify the MIME type for this flavor
* @param humanPresentableName the human-readable string used to
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/help/GHelpSet.java b/Ghidra/Framework/Docking/src/main/java/docking/help/GHelpSet.java
index ab0c363e53..b60a15a30f 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/help/GHelpSet.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/help/GHelpSet.java
@@ -40,9 +40,9 @@ import ghidra.util.SystemUtilities;
* The HelpSet class uses a javax.help.Map object to locate HTML files by javax.help.map.ID objects.
* This class has overridden that basic usage of the Map object to allow ID lookups to take
* place across GHelpSet objects. We need to do this due to how we merge help set content
- * across modules. More specifically, in order to merge, we have to make all xml tags
+ * across modules. More specifically, in order to merge, we have to make all {@code } xml tags
* the same, including the target HTML file they may reference. Well, when a module uses a
- * tag that references an HTML file not inside of it's module, then JavaHelp
+ * {@code } tag that references an HTML file not inside of it's module, then JavaHelp
* considers this an error and does not correctly merge the HelpSets that share the reference.
* Further, it does not properly locate the shared HTML file reference. This class allows lookups
* across modules by overridden the lookup functionality done by the map object. More specifically,
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
index 4d48b19f11..47046a22f7 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/help/HelpManager.java
@@ -80,7 +80,6 @@ public class HelpManager implements HelpService {
* Constructor.
*
* @param url url for the main HelpSet file for the application.
- * @param helpActionManager The HelpActionManager with which help location will be registered
* @throws HelpSetException if HelpSet could not be created
*/
protected HelpManager(URL url) throws HelpSetException {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuManager.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuManager.java
index 8bab73843e..4d7fbcfc6d 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/MenuManager.java
@@ -202,7 +202,7 @@ public class MenuManager implements ManagedMenuItem {
}
/***
- * Removes the Mnemonic indicator character (&) from the text
+ * Removes the Mnemonic indicator character (&) from the text
* @param text the text to strip
* @return the stripped mnemonic
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/menu/ToolBarItemManager.java b/Ghidra/Framework/Docking/src/main/java/docking/menu/ToolBarItemManager.java
index 223c91d687..7085f6632e 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/menu/ToolBarItemManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/menu/ToolBarItemManager.java
@@ -43,8 +43,7 @@ public class ToolBarItemManager implements PropertyChangeListener, ActionListene
/**
* Constructs a new ToolBarItemManager
* @param action the action to be managed on the toolbar.
- * @param iconSize the iconSize to scale to.
- * @param buttonListener listener for button state changes.
+ * @param windowManager the window manager.
*/
public ToolBarItemManager(DockingActionIf action, DockingWindowManager windowManager) {
this.toolBarAction = action;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/options/editor/OptionsEditorPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/options/editor/OptionsEditorPanel.java
index 34dace2a33..aae4aa4a37 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/options/editor/OptionsEditorPanel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/options/editor/OptionsEditorPanel.java
@@ -49,7 +49,9 @@ public class OptionsEditorPanel extends JPanel implements OptionsEditor {
/**
* Creates a panel for editing the given options.
* @param title The title of the options panel
- * @param optionsList The list of options to display
+ * @param options The options to display
+ * @param optionNames The list of option names
+ * @param editorStateFactory The EditorStateFactory
*/
public OptionsEditorPanel(String title, Options options, List optionNames,
EditorStateFactory editorStateFactory) {
@@ -118,10 +120,6 @@ public class OptionsEditorPanel extends JPanel implements OptionsEditor {
// OptionsEditor Interface Methods
//==================================================================================================
- /**
- * @throws InvalidInputException
- * @see ghidra.framework.options.OptionsEditor#apply()
- */
@Override
public void apply() throws InvalidInputException {
for (EditorState state : editorInfoList) {
@@ -129,9 +127,6 @@ public class OptionsEditorPanel extends JPanel implements OptionsEditor {
}
}
- /**
- * @see ghidra.framework.options.OptionsEditor#cancel()
- */
@Override
public void cancel() {
// nothing to do
@@ -142,17 +137,11 @@ public class OptionsEditorPanel extends JPanel implements OptionsEditor {
// nothing to do, as this component is reloaded when options are changed
}
- /**
- * @see ghidra.framework.options.OptionsEditor#getEditorComponent()
- */
@Override
public JComponent getEditorComponent(Options o, EditorStateFactory factory) {
return this;
}
- /**
- * @see OptionsEditor#setOptionsPropertyChangeListener(PropertyChangeListener)
- */
@Override
public void setOptionsPropertyChangeListener(PropertyChangeListener listener) {
this.propertyChangeListener = listener;
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 f2a0e37611..ef0c86bb0e 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/test/AbstractDockingTest.java
@@ -1564,7 +1564,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
*
ABCDEFGHIJKLMNOPQRSTUVWXYZ
*
abcdefghijklmnopqrstuvwxyz
*
`1234567890-=[]\;',./
- *
~!@#$%^&*()_+{}|:"<>?
+ *
{@literal ~!@#$%^&*()_+{}|:"<>?}
*
*
It also handles '\n', '\t', and '\b'.
*
@@ -1588,7 +1588,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
*
ABCDEFGHIJKLMNOPQRSTUVWXYZ
*
abcdefghijklmnopqrstuvwxyz
*
`1234567890-=[]\;',./
- *
~!@#$%^&*()_+{}|:"<>?
+ *
{@literal ~!@#$%^&*()_+{}|:"<>?}
*
*
It also handles '\n', '\t', and '\b'.
*
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/util/BadgedIcon.java b/Ghidra/Framework/Docking/src/main/java/docking/util/BadgedIcon.java
index 429cd2e83a..02402cf29c 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/util/BadgedIcon.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/util/BadgedIcon.java
@@ -230,7 +230,7 @@ public class BadgedIcon implements Icon {
/**
* Get the visibility status of the badge at the specified location
* @param position Which icon to enquire about
- * @Return True if the badge is visible, false otherwise
+ * @return True if the badge is visible, false otherwise
* @see #setBadgeVisisble(BadgePosition, boolean)
*/
public boolean isBadgeVisible(BadgePosition position) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/util/image/ToolIconURL.java b/Ghidra/Framework/Docking/src/main/java/docking/util/image/ToolIconURL.java
index 81cb1739ee..0698451074 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/util/image/ToolIconURL.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/util/image/ToolIconURL.java
@@ -243,7 +243,7 @@ public class ToolIconURL implements Comparable {
}
/**
- * Return the icon as {@link ToolConstants#ICON_SIZE} pixel size.
+ * Return the icon as {@link ToolConstants#LARGE_ICON_SIZE} pixel size.
*/
public ImageIcon getIcon() {
if (largeIcon == null) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/AbstractGCellRenderer.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/AbstractGCellRenderer.java
index cf5711f340..48c057437f 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/AbstractGCellRenderer.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/AbstractGCellRenderer.java
@@ -34,7 +34,7 @@ public abstract class AbstractGCellRenderer extends GDHtmlLabel {
private static final Color ALTERNATE_BACKGROUND_COLOR = new Color(237, 243, 254);
- /** Allows the user to disable alternating row colors on JLists & JTables */
+ /** Allows the user to disable alternating row colors on JLists and JTables */
private static final String DISABLE_ALTERNATING_ROW_COLORS_PROPERTY =
"disable.alternating.row.colors";
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java
index 667df73dd1..538bd01057 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/GComponent.java
@@ -30,9 +30,9 @@ public interface GComponent {
/**
* Enables and disables the rendering of HTML content in this component. If enabled, this
* component will interpret HTML content when the text this component is showing begins with
- * <html>
+ * {@code }
*
- * @param enable true to enable HTML rendering; false to disable it
+ * @param enabled true to enable HTML rendering; false to disable it
*/
public default void setHTMLRenderingEnabled(boolean enabled) {
setHTMLRenderingFlag((JComponent) this, enabled);
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 a8531781ef..e9bba099bb 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/OptionDialog.java
@@ -35,7 +35,7 @@ import ghidra.util.exception.AssertException;
* A utility class to easily show dialogs that require input from the user.
*
*
- * Option Dialogs
+ * Option Dialogs
*
*
* The primary type of
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/VariableHeightPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/VariableHeightPanel.java
index 5819b47e2c..6d4960e692 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/VariableHeightPanel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/VariableHeightPanel.java
@@ -93,7 +93,7 @@ public class VariableHeightPanel extends JPanel implements Scrollable {
* This method is in place because the clients of this panel are not the ones that
* construct this panel and thus cannot create the desired type of layout at construction time.
* This method has no effect if this panel was constructed with pack set to
- * false, which makes this panel use a grid style layout.
+ * false, which makes this panel use a grid style layout.
*
* @param singleLineLayout True signals to put all children on a single row; false will use
* as many rows as are needed to layout all of the children.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/AutocompletionModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/AutocompletionModel.java
index 59319e8181..08b1e57f09 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/AutocompletionModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/AutocompletionModel.java
@@ -28,7 +28,7 @@ public interface AutocompletionModel {
* @param text the prefix, i.e., the text to the left of the user's caret.
* @return a (possibly null or empty) list of suggested completions.
*
- * @note there is no requirement that the returned items actually start with the given prefix;
+ * NOTE: there is no requirement that the returned items actually start with the given prefix;
* however, by default, the displayed text for the suggested item is inserted at the caret,
* without changing the surrounding text.
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java
index 4ad7e976ad..ae6a08f322 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextFieldAutocompleter.java
@@ -58,7 +58,7 @@ import ghidra.util.task.SwingUpdateManager;
* completion is possible, it is automatically activated. This logic is applied again and again,
* until either no suggestions are given, or more than one suggestion is given (or until the
* autocompleter detects an infinite loop). This behavior can by modified on an item-by-item basis
- * by overriding the {@link #getCompletionCanDefault(T)} method. This same behavior can be
+ * by overriding the {@link #getCompletionCanDefault(Object) getCompletionCanDefault(T)} method. This same behavior can be
* activated by calling the {@link #startCompletion(JTextField)} method, which may be useful, e.g.,
* to bind a different key sequence to start autocompletion.
*
@@ -70,21 +70,20 @@ import ghidra.util.task.SwingUpdateManager;
* The simplest use case is to create a text field, create an autocompleter with a custom model,
* and then attach and show.
*
- * {@code
+ *
*
* JTextField field = new JTextField();
*
- * AutocompletionModel model = new AutocompletionModel() {
- * @Override
- * public Collection computeCompletions(String text) {
+ * {@code AutocompletionModel model = new AutocompletionModel() }{
+ * @Override
+ * {@code public Collection computeCompletions(String text)} {
* ... // Populate the completion list based on the given prefix.
* }
* }
- * TextFieldAutocompleter completer = new TextFieldAutocompleter(model);
+ * {@code TextFieldAutocompleter completer = new TextFieldAutocompleter(model);
* completer.attachTo(field);
* ... // Add the field to, e.g., a dialog, and show.
- *
- * }
+ * }
*
* @param the type of suggestions presented by this autocompleter.
*/
@@ -447,7 +446,7 @@ public class TextFieldAutocompleter {
*
* A programmer may override this if the various {@code getCompletion...} methods prove
* insufficient for customizing the display of the suggestions. Please remember that
- * {@link JLabels} can render HTML, so {@link #getCompletionDisplay(T)} is quite powerful
+ * {@link JLabel}s can render HTML, so {@link #getCompletionDisplay(Object) getCompletionDisplay(T)} is quite powerful
* with the default {@link AutocompletionCellRenderer}.
* @return a list cell renderer for the completion list.
*/
@@ -679,12 +678,12 @@ public class TextFieldAutocompleter {
* Starts the autocompleter on the given text field.
*
* First, this repeatedly attempts auto-activation. When there are many suggestions, or when
- * auto-activation is prevented (see {@link #getCompletionCanDefault(T)}), a list is displayed
+ * auto-activation is prevented (see {@link #getCompletionCanDefault(Object) getCompletionCanDefault(T)}), a list is displayed
* (usually below the caret) containing the suggestions given the fields current contents. The
* list remains open until either the user cancels it (usually via ESC) or the user activates
* a suggestion.
*
- * @note The text field must already be attached.
+ * NOTE: The text field must already be attached.
* @param field the field on which to start autocompletion.
*/
public void startCompletion(JTextField field) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java
index 9e9886eb6b..5e08fe495e 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GCheckBox.java
@@ -23,7 +23,7 @@ import docking.widgets.GComponent;
* A {@link JCheckBox} that has HTML rendering disabled.
*
* See also:
- *
+ *
* | Class | HTML rendering | Description |
|---|
* | {@link GCheckBox} | NO | HTML disabled JCheckBox |
* | {@link GHtmlCheckBox} | YES | HTML allowed JCheckBox |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java
index 3b6bb21c63..3431008622 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/checkbox/GHtmlCheckBox.java
@@ -23,7 +23,7 @@ import docking.widgets.GComponent;
* A {@link JCheckBox} that allows HTML rendering.
*
* See also:
- *
+ *
* | Class | HTML rendering | Description |
|---|
* | {@link GCheckBox} | NO | HTML disabled JCheckBox |
* | {@link GHtmlCheckBox} | YES | HTML allowed JCheckBox |
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 0d0fb281ce..f638ff626c 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
@@ -46,8 +46,8 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
*
* @param dialogTitle used as the name of the dialog's title bar
* @param label value to use for the label of the text field
- * @param String[] optionValues to populate the combo box
- * @param String initial value - can be null
+ * @param optionValues values to populate the combo box
+ * @param initialValue the initial value - can be null
* @param messageIcon the icon to display on the dialog--can be null
*/
public InputWithChoicesDialog(String dialogTitle, String label, String[] optionValues,
@@ -75,9 +75,9 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
*
* @param dialogTitle used as the name of the dialog's title bar
* @param label value to use for the label of the text field
- * @param String[] optionValues to populate the combo box
- * @param String initial value - can be null
- * @param boolean allowEdits true allows the user to add custom entries to the combo box by entering text
+ * @param optionValues values to populate the combo box
+ * @param initialValue the initial value - can be null
+ * @param allowEdits true allows the user to add custom entries to the combo box by entering text
* @param messageIcon the icon to display on the dialog--can be null
*/
public InputWithChoicesDialog(String dialogTitle, String label, String[] optionValues,
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/NumberInputDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/NumberInputDialog.java
index 31be805028..3a2ccd91fa 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/NumberInputDialog.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/NumberInputDialog.java
@@ -133,7 +133,7 @@ public class NumberInputDialog extends DialogComponentProvider {
/**
* Define the Main panel for the dialog here.
* @param showAsHex
- * @return JPanel the completed Main Panel<\CODE>
+ * @return JPanel the completed Main Panel
*/
protected JPanel buildMainPanel(String prompt, boolean showAsHex) {
JPanel panel = createPanel(prompt);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java
index 819dfead1c..bcaa0c33ab 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java
@@ -578,10 +578,10 @@ public class FieldPanel extends JPanel
}
/**
- * Add a new hover service to be managed.
+ * Add a new hover provider to be managed.
*
- * @param hoverService
- * the new hover service to be managed.
+ * @param hoverProvider
+ * the new hover provider to be managed.
*/
public void setHoverProvider(HoverProvider hoverProvider) {
hoverHandler.setHoverProvider(hoverProvider);
@@ -864,7 +864,7 @@ public class FieldPanel extends JPanel
/**
* Scrolls the display to show the layout specified by index at the vertical
* position specified by yPos. Generally, the index will be layout at the
- * top of the screen and the yPos will be <= 0, meaning the layout may be
+ * top of the screen and the yPos will be <= 0, meaning the layout may be
* partially off the top of the screen.
*
* @param index
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanelOverLayoutManager.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanelOverLayoutManager.java
index 16818a151b..7ea4bd90b9 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanelOverLayoutManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanelOverLayoutManager.java
@@ -36,7 +36,7 @@ import docking.widgets.fieldpanel.support.FieldLocation;
/**
* A {@link LayoutManager} that can be applied to a {@link FieldPanel}, allowing
- * {@link Components} to be placed over a given field location.
+ * {@link Component}s to be placed over a given field location.
*
* To apply it, use {@link Container#setLayout(LayoutManager)} to install it. In this case, the
* {@link Container} must be a {@link FieldPanel}. Then, use
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/LayoutModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/LayoutModel.java
index 2aeef517bb..08e403051c 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/LayoutModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/LayoutModel.java
@@ -98,8 +98,6 @@ public interface LayoutModel {
/**
* Returns true if the model knows about changes that haven't yet been told to the
* LayoutModelListeners.
- * @return true if changes have occurred, but no one has been notified. False if no changes
- * since last listener notification.
*/
public void flushChanges();
}
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/AbstractTextFieldElement.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/AbstractTextFieldElement.java
index 4f559b6aeb..e81cd91f5f 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/AbstractTextFieldElement.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/AbstractTextFieldElement.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,25 +47,16 @@ abstract public class AbstractTextFieldElement implements FieldElement {
this.column = column;
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getText()
- */
@Override
public String getText() {
return attributedString.getText();
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#charAt(int)
- */
@Override
public char charAt(int index) {
return attributedString.getText().charAt(index);
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#length()
- */
@Override
public int length() {
return getText().length();
@@ -76,57 +66,36 @@ abstract public class AbstractTextFieldElement implements FieldElement {
// font metrics methods
//==================================================================================================
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getStringWidth()
- */
@Override
public int getStringWidth() {
return attributedString.getStringWidth();
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return attributedString.getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return attributedString.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getMaxCharactersForWidth(int)
- */
@Override
public int getMaxCharactersForWidth(int width) {
return attributedString.getColumnPosition(width);
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getColor(int)
- */
@Override
public Color getColor(int charIndex) {
return attributedString.getColor(charIndex);
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getFieldElement(int)
- */
@Override
public FieldElement getFieldElement(int characterOffset) {
return this;
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#substring(int)
- */
@Override
public FieldElement substring(int start) {
return substring(start, attributedString.length());
@@ -140,9 +109,6 @@ abstract public class AbstractTextFieldElement implements FieldElement {
//==================================================================================================
// location info
//==================================================================================================
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getDataLocationForCharacterIndex(int)
- */
@Override
public RowColLocation getDataLocationForCharacterIndex(int characterIndex) {
if (characterIndex < 0 || characterIndex > attributedString.getText().length()) {
@@ -151,9 +117,6 @@ abstract public class AbstractTextFieldElement implements FieldElement {
return new RowColLocation(row, column + characterIndex);
}
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#getCharacterIndexForDataLocation(int, int)
- */
@Override
public int getCharacterIndexForDataLocation(int dataRow, int dataColumn) {
if (dataRow == row && (dataColumn >= column) && (dataColumn <= column + length())) {
@@ -167,9 +130,6 @@ abstract public class AbstractTextFieldElement implements FieldElement {
// paint methods
//==================================================================================================
- /**
- * @see docking.widgets.fieldpanel.field.FieldElement#paint(java.awt.Graphics, int, int)
- */
@Override
public void paint(JComponent c, Graphics g, int x, int y) {
attributedString.paint(c, g, x, y);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java
index bb25ba0477..2648ba3764 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java
@@ -95,9 +95,6 @@ public class ClippingTextField implements TextField {
textElement = textElement.substring(0, length);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x >= startX) && (x < startX + width) && (y >= -textElement.getHeightAbove()) &&
@@ -107,9 +104,6 @@ public class ClippingTextField implements TextField {
return false;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
int xPos = Math.max(x - startX, 0); // make x relative to this fields
@@ -117,9 +111,6 @@ public class ClippingTextField implements TextField {
return textElement.getMaxCharactersForWidth(xPos);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (row != 0) {
@@ -132,17 +123,11 @@ public class ClippingTextField implements TextField {
textElement.getHeightAbove() + textElement.getHeightBelow());
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return textElement.getHeightAbove() + textElement.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return getNumCols();
@@ -152,26 +137,16 @@ public class ClippingTextField implements TextField {
return textElement.length() + 1; // allow one column past the end of the text
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int,
- * int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
@@ -186,17 +161,11 @@ public class ClippingTextField implements TextField {
return -getHeightAbove() - topOfScreen;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return width;
@@ -207,9 +176,6 @@ public class ClippingTextField implements TextField {
return preferredWidth;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
if (col >= getNumCols()) {
@@ -218,33 +184,21 @@ public class ClippingTextField implements TextField {
return findX(col) + startX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return -getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return isPrimary;
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#setPrimary(boolean)
- */
@Override
public void setPrimary(boolean b) {
isPrimary = b;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
if (row != 0) {
@@ -261,11 +215,6 @@ public class ClippingTextField implements TextField {
return fullText;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics,
- * docking.widgets.fieldpanel.internal.PaintContext, boolean,
- * docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight) {
@@ -384,9 +333,6 @@ public class ClippingTextField implements TextField {
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#dataToScreenLocation(int, int)
- */
@Override
public RowColLocation dataToScreenLocation(int dataRow, int dataColumn) {
int column = textElement.getCharacterIndexForDataLocation(dataRow, dataColumn);
@@ -408,33 +354,21 @@ public class ClippingTextField implements TextField {
return isClipped;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return textElement.getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return textElement.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int heightAbove, int heightBelow) {
// Don't care
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return getString();
@@ -445,25 +379,16 @@ public class ClippingTextField implements TextField {
return getString();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return new RowColLocation(0, Math.min(textOffset, textElement.getText().length() - 1));
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return Math.min(textElement.getText().length(), col);
}
- /**
- * @see ghidra.app.util.viewer.field.ListingField#getClickedObject(FieldLocation)
- */
public Object getClickedObject(FieldLocation fieldLocation) {
return getFieldElement(fieldLocation.row, fieldLocation.col);
}
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
index 1360ffe084..0f9067f7a1 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/EmptyTextField.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -60,10 +59,6 @@ public class EmptyTextField implements Field {
return false;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return width;
@@ -74,82 +69,46 @@ public class EmptyTextField implements Field {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return height;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return -heightAbove;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
@@ -162,9 +121,6 @@ public class EmptyTextField implements Field {
return true;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight) {
@@ -182,10 +138,6 @@ public class EmptyTextField implements Field {
}
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (row != 0) {
@@ -195,10 +147,6 @@ public class EmptyTextField implements Field {
return new Rectangle(x, -heightAbove, 2, height);
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x >= startX) && (x < startX + width) && (y >= -heightAbove) &&
@@ -226,10 +174,6 @@ public class EmptyTextField implements Field {
return Color.WHITE;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
if ((topOfScreen < -heightAbove) || (topOfScreen > height - heightAbove)) {
@@ -242,9 +186,6 @@ public class EmptyTextField implements Field {
return heightAbove - topOfScreen;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return isPrimary;
@@ -258,34 +199,22 @@ public class EmptyTextField implements Field {
isPrimary = state;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return height - heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int newHeightAbove, int newHeightBelow) {
// don't care
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return "";
@@ -296,17 +225,11 @@ public class EmptyTextField implements Field {
return "";
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return new RowColLocation(0, 0);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return 0;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FlowLayoutTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FlowLayoutTextField.java
index fba061aa91..762d9ea2c5 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FlowLayoutTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/FlowLayoutTextField.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -30,7 +29,7 @@ public class FlowLayoutTextField extends VerticalLayoutTextField {
/**
* This constructor will create a text field that will render one line of
- * text. If metrics.stringWidth(text) > width, then the text
+ * text. If metrics.stringWidth(text) > width, then the text
* will be clipped. No wrapping will be performed. If text
* contains the highlight string, then it will be highlighted using the
* highlight color.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java
index bffa921952..ab5a995266 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java
@@ -108,9 +108,6 @@ public class ReverseClippingTextField implements TextField {
textStartX = startX + DOT_DOT_DOT_WIDTH + margin;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x >= startX) && (x < startX + width) && (y >= -textElement.getHeightAbove()) &&
@@ -120,9 +117,6 @@ public class ReverseClippingTextField implements TextField {
return false;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
int xPos = Math.max(x - textStartX, 0); // make x relative to this fields
@@ -130,9 +124,6 @@ public class ReverseClippingTextField implements TextField {
return textElement.getMaxCharactersForWidth(xPos);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (row != 0) {
@@ -145,17 +136,11 @@ public class ReverseClippingTextField implements TextField {
textElement.getHeightAbove() + textElement.getHeightBelow());
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return textElement.getHeightAbove() + textElement.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return getNumCols();
@@ -165,26 +150,16 @@ public class ReverseClippingTextField implements TextField {
return textElement.length() + 1; // allow one column past the end of the text
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int,
- * int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
@@ -199,17 +174,11 @@ public class ReverseClippingTextField implements TextField {
return -getHeightAbove() - topOfScreen;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return width;
@@ -220,9 +189,6 @@ public class ReverseClippingTextField implements TextField {
return preferredWidth;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
if (col >= getNumCols()) {
@@ -231,33 +197,21 @@ public class ReverseClippingTextField implements TextField {
return findX(col) + textStartX;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return -getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return isPrimary;
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#setPrimary(boolean)
- */
@Override
public void setPrimary(boolean b) {
isPrimary = b;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
if (row != 0) {
@@ -274,11 +228,6 @@ public class ReverseClippingTextField implements TextField {
return fullText;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics,
- * docking.widgets.fieldpanel.internal.PaintContext, boolean,
- * docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight) {
@@ -389,9 +338,6 @@ public class ReverseClippingTextField implements TextField {
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#dataToScreenLocation(int, int)
- */
@Override
public RowColLocation dataToScreenLocation(int dataRow, int dataColumn) {
int column = textElement.getCharacterIndexForDataLocation(dataRow, dataColumn);
@@ -413,33 +359,21 @@ public class ReverseClippingTextField implements TextField {
return isClipped;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return textElement.getHeightAbove();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return textElement.getHeightBelow();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int heightAbove, int heightBelow) {
// Don't care
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
// TODO: this gets the full string and not the clipped version--we want
@@ -452,9 +386,6 @@ public class ReverseClippingTextField implements TextField {
return getString();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
int col = textOffset + startingCharIndex;
@@ -462,9 +393,6 @@ public class ReverseClippingTextField implements TextField {
return new RowColLocation(0, Math.min(col, textElement.getText().length() - 1));
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return col + startingCharIndex;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleImageField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleImageField.java
index 4313368c35..ac6e856533 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleImageField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleImageField.java
@@ -88,10 +88,6 @@ public class SimpleImageField implements Field {
}
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x >= startX) && (x < startX + width) && (y >= -heightAbove) &&
@@ -101,19 +97,11 @@ public class SimpleImageField implements Field {
return false;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if (row != 0) {
@@ -122,46 +110,26 @@ public class SimpleImageField implements Field {
return new Rectangle(startX, -heightAbove, width, height);
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return height;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return 1;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
return 1;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
if ((topOfScreen < -heightAbove) || (topOfScreen > height - heightAbove)) {
@@ -174,19 +142,11 @@ public class SimpleImageField implements Field {
return -heightAbove - topOfScreen;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return width;
@@ -197,28 +157,16 @@ public class SimpleImageField implements Field {
return icon.getIconWidth();
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
return 0;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
return -heightAbove;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
if (row != 0) {
@@ -230,9 +178,6 @@ public class SimpleImageField implements Field {
return true;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager map, RowColLocation cursorLoc, int rowHeight) {
@@ -278,10 +223,6 @@ public class SimpleImageField implements Field {
}
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return isPrimary;
@@ -295,33 +236,21 @@ public class SimpleImageField implements Field {
isPrimary = state;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return height - heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int newHeightAbove, int newHeightBelow) {
// don't care
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
return "";
@@ -332,17 +261,11 @@ public class SimpleImageField implements Field {
return "";
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
return new RowColLocation(0, 0);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
return 0;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java
index dad543cad9..1246ad6644 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java
@@ -106,9 +106,6 @@ public class VerticalLayoutTextField implements TextField {
return widest;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getText()
- */
@Override
public String getText() {
if (text == null) {
@@ -122,18 +119,11 @@ public class VerticalLayoutTextField implements TextField {
return generateText("\n");
}
- /**
- * @see java.lang.Object#toString()
- */
@Override
public String toString() {
return getText();
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getWidth()
- */
@Override
public int getWidth() {
return width;
@@ -144,45 +134,27 @@ public class VerticalLayoutTextField implements TextField {
return preferredWidth;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getHeight()
- */
@Override
public int getHeight() {
return height;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getStartX()
- */
@Override
public int getStartX() {
return startX;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getNumRows()
- */
@Override
public int getNumRows() {
return subFields.size();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getNumCols(int)
- */
@Override
public int getNumCols(int row) {
Field f = subFields.get(row);
return f.getNumCols(0);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getRow(int)
- */
@Override
public int getRow(int y) {
if (y < -heightAbove) {
@@ -201,20 +173,12 @@ public class VerticalLayoutTextField implements TextField {
return n - 1;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCol(int, int)
- */
@Override
public int getCol(int row, int x) {
Field f = subFields.get(row);
return f.getCol(0, x);
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getY(int)
- */
@Override
public int getY(int row) {
@@ -226,20 +190,12 @@ public class VerticalLayoutTextField implements TextField {
return y;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getX(int, int)
- */
@Override
public int getX(int row, int col) {
Field f = subFields.get(row);
return f.getX(0, col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#isValid(int, int)
- */
@Override
public boolean isValid(int row, int col) {
@@ -250,9 +206,6 @@ public class VerticalLayoutTextField implements TextField {
return f.isValid(0, col);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, boolean, docking.widgets.fieldpanel.support.RowColLocation)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context,
FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight) {
@@ -308,10 +261,6 @@ public class VerticalLayoutTextField implements TextField {
g.translate(0, -height);
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getCursorBounds(int, int)
- */
@Override
public Rectangle getCursorBounds(int row, int col) {
if ((row < 0) || (row >= subFields.size())) {
@@ -326,10 +275,6 @@ public class VerticalLayoutTextField implements TextField {
return r;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#contains(int, int)
- */
@Override
public boolean contains(int x, int y) {
if ((x >= startX) && (x < startX + width) && (y >= -heightAbove) &&
@@ -339,10 +284,6 @@ public class VerticalLayoutTextField implements TextField {
return false;
}
- /**
- *
- * @see docking.widgets.fieldpanel.field.Field#getScrollableUnitIncrement(int, int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction, int max) {
@@ -364,9 +305,6 @@ public class VerticalLayoutTextField implements TextField {
}
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#isPrimary()
- */
@Override
public boolean isPrimary() {
return isPrimary;
@@ -388,25 +326,16 @@ public class VerticalLayoutTextField implements TextField {
return Collections.unmodifiableList(subFields);
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightAbove()
- */
@Override
public int getHeightAbove() {
return heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#getHeightBelow()
- */
@Override
public int getHeightBelow() {
return height - heightAbove;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#rowHeightChanged(int, int)
- */
@Override
public void rowHeightChanged(int heightAbove1, int heightBelow) {
// most fields don't care
@@ -494,9 +423,6 @@ public class VerticalLayoutTextField implements TextField {
return buf.toString();
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#screenLocationToTextOffset(int, int)
- */
@Override
public int screenLocationToTextOffset(int row, int col) {
if (row >= textElements.length) {
@@ -511,9 +437,6 @@ public class VerticalLayoutTextField implements TextField {
return len;
}
- /**
- * @see docking.widgets.fieldpanel.field.Field#textOffsetToScreenLocation(int)
- */
@Override
public RowColLocation textOffsetToScreenLocation(int textOffset) {
int extraSpace = lineDelimiter.length();
@@ -528,9 +451,6 @@ public class VerticalLayoutTextField implements TextField {
return new RowColLocation(n - 1, textElements[n - 1].getText().length());
}
- /**
- * @see docking.widgets.fieldpanel.field.TextField#isClipped()
- */
@Override
public boolean isClipped() {
return isClipped;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/FieldPanelCoordinator.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/FieldPanelCoordinator.java
index 2b89379e63..1e2e02ea0d 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/FieldPanelCoordinator.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/FieldPanelCoordinator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -80,9 +79,7 @@ public class FieldPanelCoordinator implements ViewListener {
panels = newPanels;
}
- /**
- * @see docking.widgets.fieldpanel.listener.ViewListener#viewChanged(docking.widgets.fieldpanel.FieldPanel, int, int)
- */
+ @Override
public void viewChanged(FieldPanel fp, BigInteger index, int xPos, int yPos) {
if (valuesChanging) return;
valuesChanging = true;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/LineLockedFieldPanelCoordinator.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/LineLockedFieldPanelCoordinator.java
index 16a5e930b6..d9d6717b37 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/LineLockedFieldPanelCoordinator.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/LineLockedFieldPanelCoordinator.java
@@ -113,9 +113,6 @@ public class LineLockedFieldPanelCoordinator extends FieldPanelCoordinator {
super.remove(fp);
}
- /**
- * @see docking.widgets.fieldpanel.listener.ViewListener#viewChanged(docking.widgets.fieldpanel.FieldPanel, int, int)
- */
@Override
public void viewChanged(FieldPanel fp, BigInteger index, int xPos, int yPos) {
if (valuesChanging)
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/listener/ViewListener.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/listener/ViewListener.java
index f83dc37303..1e23fe9466 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/listener/ViewListener.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/listener/ViewListener.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -27,8 +26,10 @@ public interface ViewListener {
/**
* Notifies the listener that the top of the screen has changed position.
* @param fp the field panel whose view changed.
- * @param index the index of the layout at the top of the screen
- * @param offset the y coordinate of the layout displayed at the top of the
+ * @param index the index of the layout at the top of the screen.
+ * @param xOffset the x coordinate of the layout displayed at the left of the
+ * screen.
+ * @param yOffset the y coordinate of the layout displayed at the top of the
* screen.
*/
public void viewChanged(FieldPanel fp, BigInteger index, int xOffset, int yOffset);
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 cd2ee7bd43..af911ef861 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
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -82,9 +81,8 @@ public class FieldRange implements Comparable {
/**
* checks if the given location is contained in the range.
- * @param row
- * @param column
- * @return
+ * @param loc the field location.
+ * @return true if the field range contains the specified location.
*/
public boolean contains(FieldLocation loc) {
return (loc.compareTo(start) >= 0) && (loc.compareTo(end) < 0);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldSelection.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldSelection.java
index a3443473c5..db1b5d6eba 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldSelection.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/FieldSelection.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -59,8 +58,8 @@ public class FieldSelection implements Iterable {
/**
* Returns true if the given Field at the given index is in the selection.
- * @param index the index of the layout to check if in the selection
- * @param field the index of the field in the layout to check if in the selection.
+ * @param loc the field location.
+ * @return true if the field selection contains the specified location.
*/
public boolean contains(FieldLocation loc) {
return getRangeContaining(loc) != null;
@@ -69,7 +68,7 @@ public class FieldSelection implements Iterable {
/**
* Returns the range if the given Field at the given index is in the selection.
* Otherwise returns null.
- * @param fieldLocation location to find the range for.
+ * @param loc location to find the range for.
*/
public FieldRange getRangeContaining(FieldLocation loc) {
int insertIndex = Collections.binarySearch(ranges, new FieldRange(loc, FieldLocation.MAX));
@@ -140,10 +139,8 @@ public class FieldSelection implements Iterable {
/**
* Adds a field range to this selection.
- * @param startIndex the layout index of the start field
- * @param startField the index of the field in the start layout.
- * @param endIndex the layout index of the end field.
- * @param endField the index of the field in the end layout.
+ * @param start the starting field location.
+ * @param end the ending field location.
*/
public void addRange(FieldLocation start, FieldLocation end) {
if (start.equals(end)) {
@@ -204,10 +201,8 @@ public class FieldSelection implements Iterable {
/**
* Removes the given field range from the current selection.
- * @param startIndex the layout index of the startField to remove from the selection
- * @param startField the field index of first field to remove from the selection
- * @param endIndex the layout index of the endField to remove from the selection.
- * @param endField the field index of the last field to remove from the selection.
+ * @param start the starting field location.
+ * @param end the ending field location.
*/
public void removeRange(FieldLocation start, FieldLocation end) {
FieldRange deleteRange = new FieldRange(start, end);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HoverProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HoverProvider.java
index fb785aa9a7..d8eaed33f9 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HoverProvider.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HoverProvider.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,7 +39,6 @@ public interface HoverProvider {
* @param field the field over which the mouse is hovering
* @param fieldBounds the rectangle containing the bounds of the given field.
* @param event the last mouse motion event over the field viewer component (i.e., FieldPanel).
- * @return true if a popup window has been displayed adjacent to the mouse location.
*/
public void mouseHovered(FieldLocation fieldLocation, Field field, Rectangle fieldBounds,
MouseEvent event);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/MultiRowLayout.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/MultiRowLayout.java
index 04424019f0..67aff7150b 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/MultiRowLayout.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/MultiRowLayout.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -74,10 +73,6 @@ public class MultiRowLayout implements Layout {
offsets[layouts.length] = soFar;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getHeight()
- */
@Override
public int getHeight() {
return heightAbove + heightBelow;
@@ -96,19 +91,11 @@ public class MultiRowLayout implements Layout {
return max;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getNumFields()
- */
@Override
public int getNumFields() {
return numFields;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getField(int)
- */
@Override
public Field getField(int index) {
for (int i = 0; i < layouts.length; i++) {
@@ -119,9 +106,6 @@ public class MultiRowLayout implements Layout {
return null;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, java.awt.Rectangle, ghidra.util.bean.field.LayoutSelection, ghidra.util.bean.field.LayoutSelection, int, int, int)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context, Rectangle rect,
LayoutBackgroundColorManager colorManager, FieldLocation cursorLocation) {
@@ -151,10 +135,6 @@ public class MultiRowLayout implements Layout {
rect.y += totalShift;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#setCursor(docking.widgets.fieldpanel.support.FieldLocation, int, int)
- */
@Override
public int setCursor(FieldLocation cursorLoc, int x, int y) {
int offset = 0;
@@ -169,10 +149,6 @@ public class MultiRowLayout implements Layout {
return layouts[0].setCursor(cursorLoc, x, y);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getCursorRect(int, int, int)
- */
@Override
public Rectangle getCursorRect(int fieldNum, int row, int col) {
int offset = 0;
@@ -189,10 +165,6 @@ public class MultiRowLayout implements Layout {
return null;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorUp(docking.widgets.fieldpanel.support.FieldLocation, int)
- */
@Override
public boolean cursorUp(FieldLocation cursorLoc, int lastX) {
int row = findRow(cursorLoc);
@@ -210,10 +182,6 @@ public class MultiRowLayout implements Layout {
return result;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorDown(docking.widgets.fieldpanel.support.FieldLocation, int)
- */
@Override
public boolean cursorDown(FieldLocation cursorLoc, int lastX) {
int row = findRow(cursorLoc);
@@ -232,10 +200,6 @@ public class MultiRowLayout implements Layout {
return result;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorBeginning(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorBeginning(FieldLocation cursorLoc) {
int row = findRow(cursorLoc);
@@ -245,10 +209,6 @@ public class MultiRowLayout implements Layout {
return lastX;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorEnd(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorEnd(FieldLocation cursorLoc) {
int row = findRow(cursorLoc);
@@ -258,10 +218,6 @@ public class MultiRowLayout implements Layout {
return lastX;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorLeft(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorLeft(FieldLocation cursorLoc) {
int row = findRow(cursorLoc);
@@ -279,10 +235,6 @@ public class MultiRowLayout implements Layout {
return returnVal;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorRight(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorRight(FieldLocation cursorLoc) {
int row = findRow(cursorLoc);
@@ -300,10 +252,6 @@ public class MultiRowLayout implements Layout {
return returnVal;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#enterLayout(docking.widgets.fieldpanel.support.FieldLocation, int, boolean)
- */
@Override
public boolean enterLayout(FieldLocation cursorLoc, int lastX, boolean fromTop) {
if (fromTop) {
@@ -315,10 +263,6 @@ public class MultiRowLayout implements Layout {
return result;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getScrollableUnitIncrement(int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction) {
int searchPoint = topOfScreen;
@@ -337,10 +281,6 @@ public class MultiRowLayout implements Layout {
direction);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#contains(int)
- */
@Override
public boolean contains(int yPos) {
if ((yPos >= 0) && (yPos < heightAbove + heightBelow)) {
@@ -420,9 +360,6 @@ public class MultiRowLayout implements Layout {
}
}
- /**
- * @see docking.widgets.fieldpanel.Layout#getPrimaryOffset()
- */
@Override
public int getPrimaryOffset() {
if (primaryOffset == -1) {
@@ -442,9 +379,6 @@ public class MultiRowLayout implements Layout {
primaryOffset = 0;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#getFieldBounds(int)
- */
@Override
public Rectangle getFieldBounds(int index) {
int offset = 0;
@@ -460,18 +394,12 @@ public class MultiRowLayout implements Layout {
}
- /**
- * @see docking.widgets.fieldpanel.Layout#insertSpaceAbove(int)
- */
@Override
public void insertSpaceAbove(int size) {
layouts[0].insertSpaceAbove(size);
heightAbove += size;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#insertSpaceBelow(int)
- */
@Override
public void insertSpaceBelow(int size) {
layouts[layouts.length - 1].insertSpaceBelow(size);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/RowLayout.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/RowLayout.java
index 75927209ea..df9c58dbd9 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/RowLayout.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/RowLayout.java
@@ -61,10 +61,6 @@ public class RowLayout implements Layout {
}
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getHeight()
- */
@Override
public int getHeight() {
return heightAbove + heightBelow;
@@ -116,43 +112,26 @@ public class RowLayout implements Layout {
return rowID;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#insertSpaceAbove(int)
- */
@Override
public void insertSpaceAbove(int size) {
heightAbove += size;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#insertSpaceBelow(int)
- */
@Override
public void insertSpaceBelow(int size) {
heightBelow += size;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getNumFields()
- */
@Override
public int getNumFields() {
return fields.length;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getField(int)
- */
@Override
public Field getField(int index) {
return fields[index];
}
- /**
- * @see docking.widgets.fieldpanel.Layout#paint(java.awt.Graphics, docking.widgets.fieldpanel.internal.PaintContext, java.awt.Rectangle, docking.widgets.fieldpanel.support.field.LayoutSelection, docking.widgets.fieldpanel.support.field.LayoutSelection, int, int, int)
- */
@Override
public void paint(JComponent c, Graphics g, PaintContext context, Rectangle rect,
LayoutBackgroundColorManager colorManager, FieldLocation cursorLocation) {
@@ -209,10 +188,6 @@ public class RowLayout implements Layout {
}
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#setCursor(docking.widgets.fieldpanel.support.FieldLocation, int, int)
- */
@Override
public int setCursor(FieldLocation cursorLoc, int x, int y) {
@@ -229,10 +204,6 @@ public class RowLayout implements Layout {
return field.getX(cursorLoc.row, cursorLoc.col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getCursorRect(int, int, int)
- */
@Override
public Rectangle getCursorRect(int fieldNum, int row, int col) {
if (fieldNum >= fields.length) { // somehow we got a call where this happened
@@ -247,10 +218,6 @@ public class RowLayout implements Layout {
return null;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorUp(docking.widgets.fieldpanel.support.FieldLocation, int)
- */
@Override
public boolean cursorUp(FieldLocation cursorLoc, int lastX) {
if (cursorLoc.row > 0) {
@@ -261,10 +228,6 @@ public class RowLayout implements Layout {
return false;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorDown(docking.widgets.fieldpanel.support.FieldLocation, int)
- */
@Override
public boolean cursorDown(FieldLocation cursorLoc, int lastX) {
if (cursorLoc.row < fields[cursorLoc.fieldNum].getNumRows() - 1) {
@@ -275,10 +238,6 @@ public class RowLayout implements Layout {
return false;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorBeginning(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorBeginning(FieldLocation cursorLoc) {
@@ -290,10 +249,6 @@ public class RowLayout implements Layout {
return field.getX(cursorLoc.row, cursorLoc.col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorEnd(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorEnd(FieldLocation cursorLoc) {
Field field = fields[fields.length - 1];
@@ -304,10 +259,6 @@ public class RowLayout implements Layout {
return field.getX(cursorLoc.row, cursorLoc.col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorLeft(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorLeft(FieldLocation cursorLoc) {
if (cursorLoc.col > 0) {
@@ -334,10 +285,6 @@ public class RowLayout implements Layout {
return fields[cursorLoc.fieldNum].getX(cursorLoc.row, cursorLoc.col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#cursorRight(docking.widgets.fieldpanel.support.FieldLocation)
- */
@Override
public int cursorRight(FieldLocation cursorLoc) {
if (cursorLoc.col < fields[cursorLoc.fieldNum].getNumCols(cursorLoc.row) - 1) {
@@ -362,10 +309,6 @@ public class RowLayout implements Layout {
return fields[cursorLoc.fieldNum].getX(cursorLoc.row, cursorLoc.col);
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#enterLayout(docking.widgets.fieldpanel.support.FieldLocation, int, boolean)
- */
@Override
public boolean enterLayout(FieldLocation cursorLoc, int lastX, boolean fromTop) {
// locate the field that the cursor will enter
@@ -387,10 +330,6 @@ public class RowLayout implements Layout {
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#getScrollableUnitIncrement(int, int)
- */
@Override
public int getScrollableUnitIncrement(int topOfScreen, int direction) {
int max = 0;
@@ -420,10 +359,6 @@ public class RowLayout implements Layout {
return max;
}
- /**
- *
- * @see docking.widgets.fieldpanel.Layout#contains(int)
- */
@Override
public boolean contains(int yPos) {
if ((yPos >= 0) && (yPos < heightAbove + heightBelow)) {
@@ -487,9 +422,7 @@ public class RowLayout implements Layout {
// int width = end-start;
// g.fillRect(start,0,width,heightAbove+heightBelow);
// }
- /**
- * @see docking.widgets.fieldpanel.Layout#getPrimaryOffset()
- */
+
@Override
public int getPrimaryOffset() {
return 0;
@@ -499,9 +432,6 @@ public class RowLayout implements Layout {
return isPrimary;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#getFieldBounds(int)
- */
@Override
public Rectangle getFieldBounds(int index) {
Field f = fields[index];
@@ -511,9 +441,6 @@ public class RowLayout implements Layout {
return rect;
}
- /**
- * @see docking.widgets.fieldpanel.Layout#getIndexSize()
- */
@Override
public int getIndexSize() {
return 1;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/ViewerPosition.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/ViewerPosition.java
index fd54531d65..e067d1fe94 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/ViewerPosition.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/ViewerPosition.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,7 +36,7 @@ public class ViewerPosition implements Serializable {
* @param xOffset The horizontal scroll position (NOT CURRENTLY USED)
* @param yOffset the vertical position of the layout at the top of the screen.
* If the the layout is totally visible, then the yOffset will be 0. Otherwise,
- * it will be < 0 indicating that it begins above the top of the screen.
+ * it will be < 0 indicating that it begins above the top of the screen.
*/
public ViewerPosition(BigInteger index, int xOffset, int yOffset) {
this.index = index;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java
index 2b2fed254f..d70b0b80c0 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDHtmlLabel.java
@@ -25,7 +25,7 @@ import docking.widgets.checkbox.GHtmlCheckBox;
* A 'dynamic' label (the text can be changed), with HTML rendering allowed.
*
* See also:
- *
+ *
* | Class | Mutable text | HTML rendering | Description |
|---|
* | {@link GLabel} | Immutable | NO | Non-html unchangeable label |
* | {@link GDLabel} | Mutable | NO | Non-html changeable label |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java
index 240ef04605..ec12e5e983 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GDLabel.java
@@ -25,7 +25,7 @@ import docking.widgets.checkbox.GHtmlCheckBox;
* A 'dynamic' label (the text can be changed), with HTML rendering disabled.
*
* See also:
- *
+ *
* | Class | Mutable text | HTML rendering | Description |
|---|
* | {@link GLabel} | Immutable | NO | Non-html unchangeable label |
* | {@link GDLabel} | Mutable | NO | Non-html changeable label |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java
index 6270f9f7c4..67499480d0 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GHtmlLabel.java
@@ -29,7 +29,7 @@ import utilities.util.reflection.ReflectionUtilities;
* An immutable label (the text can NOT be changed), with HTML rendering allowed.
*
* See also:
- *
+ *
* | Class | Mutable text | HTML rendering | Description |
|---|
* | {@link GLabel} | Immutable | NO | Non-html unchangeable label |
* | {@link GDLabel} | Mutable | NO | Non-html changeable label |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java
index b9ca14f595..be56868950 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GIconLabel.java
@@ -29,7 +29,7 @@ import utilities.util.reflection.ReflectionUtilities;
* A label that only contains an image and no text.
*
* See also:
- *
+ *
* | Class | Mutable text | HTML rendering | Description |
|---|
* | {@link GLabel} | Immutable | NO | Non-html unchangeable label |
* | {@link GDLabel} | Mutable | NO | Non-html changeable label |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java
index fe9d9666e3..fa4f702cfd 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/label/GLabel.java
@@ -29,7 +29,7 @@ import utilities.util.reflection.ReflectionUtilities;
* An immutable label (the text can NOT be changed), with HTML rendering disabled.
*
* See also:
- *
+ *
* | Class | Mutable text | HTML rendering | Description |
|---|
* | {@link GLabel} | Immutable | NO | Non-html unchangeable label |
* | {@link GDLabel} | Mutable | NO | Non-html changeable label |
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/pathmanager/PathManager.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/pathmanager/PathManager.java
index 556aa1b86c..ac323129e3 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/pathmanager/PathManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/pathmanager/PathManager.java
@@ -110,7 +110,7 @@ public class PathManager {
* Add a new file path and set its enablement
* @param file
* @param enabled
- * @returns true if the enabled path did not already exist
+ * @return true if the enabled path did not already exist
*/
public boolean addPath(ResourceFile file, boolean enabled) {
ResourceFile dir = file.isDirectory() ? file : file.getParentFile();
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DefaultTableCellRendererWrapper.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DefaultTableCellRendererWrapper.java
index 7aaaa81bd9..a298d08051 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DefaultTableCellRendererWrapper.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/DefaultTableCellRendererWrapper.java
@@ -37,7 +37,7 @@ public class DefaultTableCellRendererWrapper extends GTableCellRenderer {
/**
* Enables and disables the rendering of HTML content in this renderer. If enabled, this
* renderer will interpret HTML content when the text this renderer is showing begins with
- * <html>
+ * {@code }
*
* @param enable true to enable HTML rendering; false to disable it
*/
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/FilterTypeConverter.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/FilterTypeConverter.java
index a4f6e78e9a..760d196b2d 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/FilterTypeConverter.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/FilterTypeConverter.java
@@ -22,9 +22,6 @@ import ghidra.docking.settings.Settings;
* and convert it to the specified type. This class is meant to be used when the dynamic
* filtering mechanism is not correctly filtering a column, usually because the default filter
* for the column type does not match what the renderer is displaying in the table.
- *
- * Columns create one of these classes to be returned from
- * {@link DynamicTableColumn#getFilterConverter()}.
*
* @param the column type
* @param the new type to be used during filter operations
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 589d190182..61e74f1ba4 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
@@ -241,7 +241,7 @@ public abstract class GDynamicColumnTableModel
* implementations to add custom column objects, rather than relying on generic, discovered
* DynamicTableColumn implementations.
*
- * Note: this method assumes that the columns have already been sorted
+ *
Note: this method assumes that the columns have already been sorted
* @param column The field to add
*/
protected void addTableColumn(DynamicTableColumn column) {
@@ -269,7 +269,7 @@ public abstract class GDynamicColumnTableModel
* This method is intended for implementations to add custom column objects, rather than
* relying on generic, discovered DynamicTableColumn implementations.
*
- * Note: this method assumes that the columns have already been sorted.
+ * Note: this method assumes that the columns have already been sorted.
* @param column The field to add.
* @param index The index at which to add the field. If the index value is invalid (negative
* or greater than the number of columns), then the column will be added to the
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/MappedColumnConstraint.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/MappedColumnConstraint.java
index f748a4672d..5a55333eb7 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/MappedColumnConstraint.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/MappedColumnConstraint.java
@@ -22,7 +22,7 @@ import ghidra.util.SystemUtilities;
/**
* Class that maps one type of column constraint into another. Typically, these are created
* automatically based on {@link ColumnTypeMapper} that are discovered by the system. For example,
- * if you have a column type of "Foo", and you create a ColumnTypeMapper, then all the
+ *{@literal if you have a column type of "Foo", and you create a ColumnTypeMapper, then all the}
* string constraints would now be available that column.
*
* @param The column type.
@@ -94,7 +94,7 @@ public class MappedColumnConstraint implements ColumnConstraint {
/**
* Returns the delegate constraint (current value for this mapped constraint)
- * @return the delegate constraint.
+ * @return the delegate constraint.
*/
public ColumnConstraint getDelegate() {
return delegate;
@@ -129,8 +129,8 @@ public class MappedColumnConstraint implements ColumnConstraint {
}
/**
- * Class for converting a ColumnDataSource to a ColumnDataSource to be used when
- * getting the editor for the delegate ColumnConstraint.
+ * {@literal Class for converting a ColumnDataSource to a ColumnDataSource to be used when}
+ * getting the editor for the delegate{@literal ColumnConstraint.}
*/
protected class DelegateColumnData implements ColumnData {
@@ -138,7 +138,7 @@ public class MappedColumnConstraint implements ColumnConstraint {
/**
* Constructor
- * @param columnDataSource the ColumnDataSource whose T data will be converted to
+ * @param columnDataSource the{@literal ColumnDataSource} whose T data will be converted to
* W data for the delegate editor.
*/
public DelegateColumnData(ColumnData columnDataSource) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/StringEndsWithColumnConstraint.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/StringEndsWithColumnConstraint.java
index 202b3eb567..a2216f96fe 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/StringEndsWithColumnConstraint.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constraint/StringEndsWithColumnConstraint.java
@@ -26,7 +26,7 @@ public class StringEndsWithColumnConstraint extends StringColumnConstraint {
/**
* Constructor
- * @param spec the string to use to create an "ends with" pattern.
+ * @param patternString the string to use to create an "ends with" pattern.
*/
public StringEndsWithColumnConstraint(String patternString) {
super(patternString);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AutocompletingStringConstraintEditor.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AutocompletingStringConstraintEditor.java
index 71d62c63ed..ae37ed1350 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AutocompletingStringConstraintEditor.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/constrainteditor/AutocompletingStringConstraintEditor.java
@@ -34,7 +34,7 @@ import ghidra.util.HTMLUtilities;
/**
* An editor that provides suggestions of values that, according to
- * {@linkplain StringMatchStrategy}, match a user-supplied
+ * {@linkplain StringColumnConstraint}, match a user-supplied
* pattern.
*/
public class AutocompletingStringConstraintEditor extends DataLoadingConstraintEditor {
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 a6402af288..34e5e83257 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
@@ -96,7 +96,7 @@ public class EnumConstraintEditor> extends AbstractColumnConst
* getName(), getDisplayName(), or getDisplayString()
* before falling back to toString().
*
- * @returns a more user-friendly name for the value
+ * @return a more user-friendly name for the value
*/
public String getElementDisplayName(T value) {
String displayName = getDisplayNameUsingMethodNamed("getName", value);
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 ab581f01de..90730e7de7 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
@@ -401,7 +401,7 @@ public class TableUpdateJob {
/**
* Gets any existing data that matches the current filter, if any.
- * @returns data that should be the start point for the next filter state; null if there
+ * @return data that should be the start point for the next filter state; null if there
* is no filter set or if the current data's filter does not match the pending filter
*/
private TableData getReusableFilteredData() {
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 5b95ac7a4a..e97f39895e 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
@@ -20,8 +20,7 @@ import ghidra.framework.plugintool.ServiceProviderStub;
import ghidra.util.task.TaskMonitor;
/**
- * A version of {@link ThreadedTableModel} for clients that do not need a
- * {@link ThreadedTableModel#DATA_SOURCE}.
+ * 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
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/TextFieldLinker.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/TextFieldLinker.java
index 325ad3a32d..2e351ecfa3 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/TextFieldLinker.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/textfield/TextFieldLinker.java
@@ -36,7 +36,7 @@ import org.apache.commons.lang3.StringUtils;
*
* This fulfills a similar purpose to formatted text fields, except the individual parts may be
* placed independent of the other components. Granted, they ought to appear in an intuitive order.
- * The input string is split among a collection of {@link JTextFields} each according to a given
+ * The input string is split among a collection of {@link JTextField}s each according to a given
* pattern -- excluding the final field. Cursor navigation, insertion, deletion, etc. are all
* applied as if the linked text fields were part of a single composite text field.
*
@@ -492,7 +492,7 @@ public class TextFieldLinker {
* {@link #linkLastField(JTextField)}. Thus, before linking is actually activated, at least one
* field must be present. To be meaningful, at least two fields should be linked.
*
- * @note {@code exp} must match {@code sep}.
+ * NOTE: {@code exp} must match {@code sep}.
*
* @param field the field to link
* @param exp the separator following the field
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 86889f0e37..cf98ee930c 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
@@ -54,7 +54,7 @@ import util.CollectionUtils;
* 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,
- * the {@link #equals()} method has been implemented such that nodes are considered equal if they have
+ * 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
* available in a generic GTreeNode.
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeTask.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeTask.java
index 47131a9b59..3935a7dfba 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeTask.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTreeTask.java
@@ -53,7 +53,6 @@ public abstract class GTreeTask extends PriorityJob {
* values on later calls to getSelectedPaths(). So, to handle that 'feature' of the JTree, we
* need to translate the given path to the equivalent path in the current tree (this code may
* not be needed in all uses of this task, but it protects us from the aforementioned case).
- * @throws CancelledException
*/
protected TreePath translatePath(TreePath path, TaskMonitor monitor) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/internal/GTreeModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/internal/GTreeModel.java
index a147e89f77..c4442df246 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/internal/GTreeModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/internal/GTreeModel.java
@@ -39,8 +39,6 @@ public class GTreeModel implements TreeModel {
* Constructs a GTreeModel with the given root node.
*
* @param root The root of the tree.
- * @param isThreaded True signals to perform all tree tasks in a threaded environment to
- * avoid hanging the swing thread.
*/
public GTreeModel(GTreeNode root) {
this.root = root;
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/wizard/MagePanel.java b/Ghidra/Framework/Docking/src/main/java/docking/wizard/MagePanel.java
index a1a7fcc2d2..fed36998b2 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/wizard/MagePanel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/wizard/MagePanel.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -25,9 +24,6 @@ public interface MagePanel extends WizardPanel {
* whether you must, can, or should not be displayed.
* @param state the state object
* @return displayability
- * @throws IllegalPanelStateException indicates that something bad has happened and we should
- * return to the very first panel - unless we are the first panel in which case we
- * should abort the wizard.
*/
public WizardPanelDisplayability getPanelDisplayabilityAndUpdateState(WizardState state);
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardManager.java b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardManager.java
index 459ef295ff..fc2d67dbaa 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardManager.java
@@ -155,7 +155,6 @@ public class WizardManager extends DialogComponentProvider implements WizardPane
/**
* Notification that the wizard process is complete.
* @param success status of the process
- * @param msg message to display in the dialog's status area
*/
public void completed(boolean success) {
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardStateDependencyValidator.java b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardStateDependencyValidator.java
index c65dc1b515..69d3d3ccc9 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardStateDependencyValidator.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/wizard/WizardStateDependencyValidator.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,7 +30,7 @@ public class WizardStateDependencyValidator {
* the dependent is registered such that a call to {@link #findAffectedDependants(WizardState)}
* will include that property key only if its cached value is null. (i.e. the first time it
* is called.)
- * @param dependant the property key that depends on a previous property being set.
+ * @param dependent the property key that depends on a previous property being set.
* @param predecessor the property key of the property that affects the dependent property.
*/
public void addDependency(T dependent, T predecessor) {
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 bfc25f9a5e..92d945712a 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
@@ -19,9 +19,7 @@ import ghidra.util.SignednessFormatMode;
/**
* The settings definition for the numeric display format for handling signed values.
- *
- *
- *
+ *
*/
public class IntegerSignednessFormattingModeSettingsDefinition implements EnumSettingsDefinition {
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/CachingSwingWorker.java b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/CachingSwingWorker.java
index a46dc712a6..178c2f0116 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/CachingSwingWorker.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/CachingSwingWorker.java
@@ -102,7 +102,7 @@ public abstract class CachingSwingWorker implements CachingLoader {
*
* @param monitor the monitor (may be null)
* @return the object that this class is managing/caching
- * @see #get()
+ * @see #getCachedValue()
*/
@Override
public T get(TaskMonitor monitor) {
diff --git a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/RunManager.java b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/RunManager.java
index 76c91f00eb..af96c01372 100644
--- a/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/RunManager.java
+++ b/Ghidra/Framework/Docking/src/main/java/ghidra/util/task/RunManager.java
@@ -45,9 +45,9 @@ import ghidra.util.worker.Worker;
* If the given runnable has Swing work to perform after the main Runnable.run() method completes
* (e.g., updating Swing components),
* the runnable should implement the {@link SwingRunnable} interface and perform this work in
- * {@link SwingRunnable#swingRun()}.
+ * {@link SwingRunnable#swingRun(boolean)}.
*
- * The progress monitor component, retrieved via {@link #getTaskMonitorComponent()}, can be placed
+ * The progress monitor component, retrieved via {@link #getMonitorComponent()}, can be placed
* into a Swing widget. This RunManager will show and hide this progress component as necessary
* when runnables are being run.
*
@@ -220,7 +220,7 @@ public class RunManager {
/**
* Schedules this runnable to be run after all runnables currently queued.
*
- * This method differs from the {@link #runNow(Runnable, String, int)} methods in that it will
+ * This method differs from the {@link #runNow(MonitoredRunnable, String, int)} methods in that it will
* not cancel any currently running jobs. This allows you to add new jobs to this run
* manager, which lets them queue up. See header docs for details.
*
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 01f9c548c3..cb9fdca552 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
@@ -33,7 +33,7 @@ import util.CollectionUtils;
* the {@link Task} interface, which means less boiler-plate code.
*
*
An example of usage:
- *
+ * {@literal
* MonitoredRunnable r =
* monitor -> doWork(parameter, monitor);
* new TaskBuilder("Task Title", r)
@@ -41,18 +41,18 @@ import util.CollectionUtils;
* .setCanCancel(true)
* .setStatusTextAlignment(SwingConstants.LEADING)
* .launchModal();
- *
+ * }
*
* Or,
*
- *
+ * {@literal
* TaskBuilder.withRunnable(monitor -> doWork(parameter, monitor))
* .setTitle("Task Title")
* .setHasProgress(true)
* .setCanCancel(true)
* .setStatusTextAlignment(SwingConstants.LEADING)
* .launchModal();
- *
+ * }
*
* Or,
*
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 0c8b110a8a..2f767830c6 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
@@ -69,7 +69,7 @@ public class TaskLauncher {
*
* TaskLauncher.launchNonModal( "My task",
* null, // parent
- * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
+ * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
* );
*
*
@@ -99,7 +99,7 @@ public class TaskLauncher {
*
* TaskLauncher.launchModal( "My task",
* null, // parent
- * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
+ * monitor -> { while ( !monitor.isCanceled() ) { longRunningWork(); } }
* );
*
*
@@ -132,7 +132,7 @@ public class TaskLauncher {
*
*
* TaskLauncher.launchModal( "My task",
- * monitor -> { { foo(); }
+ * monitor -> { { foo(); }
* );
*
*
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientAuthenticator.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientAuthenticator.java
index a478d37957..eb215593d9 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientAuthenticator.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientAuthenticator.java
@@ -38,14 +38,14 @@ public interface ClientAuthenticator extends KeyStorePasswordProvider {
* @param serverType type of server (label associated with serverName)
* @param serverName name of server
* @param nameCb provides storage for user login name. A null indicates
- * that the default user name will be used, @see ClientUtil#getUserName().
+ * that the default user name will be used, @see ClientUtil#getUserName()
* @param passCb provides storage for user password, @see PasswordCallback#setPassword(char[])
* @param choiceCb specifies choice between NT Domain authentication (index=0) and local password
* file authentication (index=1). Set selected index to specify authenticator to be used,
* @param anonymousCb may be used to request anonymous read-only access to
* the server. A null is specified if anonymous access has not been enabed on the server.
* @param loginError previous login error message or null for first attempt
- * @see ChoiceCallback#setSelectedIndex(int).
+ * @see ChoiceCallback#setSelectedIndex(int)
* A null is specified if no choice is available (password authenticator determined by server configuration).
* @see AnonymousCallback#setAnonymousAccessRequested(boolean)
* @return
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientUtil.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientUtil.java
index 3896db1727..3b4d1dbe2d 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientUtil.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/ClientUtil.java
@@ -84,8 +84,6 @@ public class ClientUtil {
* @param host server name or address
* @param port server port, 0 indicates that default port should be used.
* @return repository server adapter
- * @throws LoginException thrown if server fails to authenticate user or
- * general access is denied.
*/
public static RepositoryServerAdapter getRepositoryServer(String host, int port) {
return getRepositoryServer(host, port, false);
@@ -100,8 +98,6 @@ public class ClientUtil {
* @param forceConnect if true and the server adapter is disconnected, an
* attempt will be made to reconnect.
* @return repository server handle
- * @throws LoginException thrown if server fails to authenticate user or
- * general access is denied.
*/
public static RepositoryServerAdapter getRepositoryServer(String host, int port,
boolean forceConnect) {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryAdapter.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryAdapter.java
index 77d5df9f24..ef42c7f013 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryAdapter.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryAdapter.java
@@ -158,7 +158,6 @@ public class RepositoryAdapter implements RemoteAdapterListener {
/**
* Attempt to connect to the server.
- * @return true if connected
*/
public void connect() throws IOException {
synchronized (serverAdapter) {
@@ -326,7 +325,7 @@ public class RepositoryAdapter implements RemoteAdapterListener {
* @throws IOException
* @throws UserAccessException user no longer has any permission to use repository.
* @throws NotConnectedException if server/repository connection is down (user already informed)
- * @see ghidra.framework.remote.RemoteRepositoryHandle#getUserList()
+ * @see RemoteRepositoryHandle#getUserList()
*/
public User[] getUserList() throws IOException {
synchronized (serverAdapter) {
@@ -348,7 +347,7 @@ public class RepositoryAdapter implements RemoteAdapterListener {
* @throws IOException
* @throws UserAccessException user no longer has any permission to use repository.
* @throws NotConnectedException if server/repository connection is down (user already informed)
- * @see ghidra.framework.remote.RemoteRepositoryHandle#getServerUserList()
+ * @see RemoteRepositoryHandle#getServerUserList()
*/
public String[] getServerUserList() throws IOException {
synchronized (serverAdapter) {
@@ -373,7 +372,7 @@ public class RepositoryAdapter implements RemoteAdapterListener {
* @throws UserAccessException
* @throws IOException
* @throws NotConnectedException if server/repository connection is down (user already informed)
- * @see ghidra.framework.remote.RemoteRepositoryHandle#setUserList(ghidra.framework.remote.User[])
+ * @see RemoteRepositoryHandle#setUserList(User[], boolean)
*/
public void setUserList(User[] users, boolean anonymousAccessAllowed) throws IOException {
synchronized (serverAdapter) {
@@ -391,8 +390,8 @@ public class RepositoryAdapter implements RemoteAdapterListener {
}
}
- /*
- * @see ghidra.framework.remote.RepositoryHandle#createDatabase(java.lang.String, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)
+ /**
+ * @see RepositoryHandle#createDatabase(String, String, String, int, String, String)
*/
public ManagedBufferFileAdapter createDatabase(String parentPath, String itemName,
int bufferSize, String contentType, String fileID, String projectPath)
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryServerAdapter.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryServerAdapter.java
index c22084a17e..4d87877078 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryServerAdapter.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/client/RepositoryServerAdapter.java
@@ -299,7 +299,7 @@ public class RepositoryServerAdapter {
* @throws UserAccessException
* @throws IOException
* @throws NotConnectedException if server connection is down (user already informed)
- * @see ghidra.framework.remote.RemoteRepositoryServerHandle#createRepository(java.lang.String, long)
+ * @see ghidra.framework.remote.RemoteRepositoryServerHandle#createRepository(String)
*/
public synchronized RepositoryAdapter createRepository(String name)
throws DuplicateNameException, UserAccessException, IOException, NotConnectedException {
@@ -398,7 +398,7 @@ public class RepositoryServerAdapter {
}
/**
- * @returns true if server allows anonymous access.
+ * @return true if server allows anonymous access.
* Individual repositories must grant anonymous access separately.
* @throws IOException
* @throws NotConnectedException if server connection is down (user already informed)
@@ -418,7 +418,7 @@ public class RepositoryServerAdapter {
}
/**
- * @returns true if user has restricted read-only access to server (e.g., anonymous user)
+ * @return true if user has restricted read-only access to server (e.g., anonymous user)
* @throws IOException
* @throws NotConnectedException if server connection is down (user already informed)
* @see ghidra.framework.remote.RemoteRepositoryServerHandle#isReadOnly()
@@ -469,7 +469,7 @@ public class RepositoryServerAdapter {
* @throws IOException if user data can't be written to file
* @throws NotConnectedException if server connection is down (user already informed)
* @see ghidra.framework.remote.RemoteRepositoryServerHandle#setPassword(char[])
- * @see HashUtilities#getSaltedHash("SHA-256", char[])
+ * @see ghidra.util.HashUtilities#getSaltedHash(String, char[]) HashUtilities.getSaltedHash("SHA-256", char[])
*/
public synchronized boolean setPassword(char[] saltedSHA256PasswordHash)
throws IOException, NotConnectedException {
@@ -487,8 +487,6 @@ public class RepositoryServerAdapter {
/**
* Returns true if this server allows the user to change their password.
- * @throws IOException
- * @throws NotConnectedException if server connection is down (user already informed)
* @see ghidra.framework.remote.RemoteRepositoryServerHandle#canSetPassword()
*/
public synchronized boolean canSetPassword() {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/AnonymousCallback.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/AnonymousCallback.java
index da9b783b71..b44b29e02e 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/AnonymousCallback.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/AnonymousCallback.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,7 +34,7 @@ public class AnonymousCallback implements Callback, Serializable {
}
/**
- * @returns true if anonymous access requested
+ * @return true if anonymous access requested
*/
public boolean anonymousAccessRequested() {
return anonymousAccessRequested;
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryHandle.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryHandle.java
index ab7b7b7985..9887a05519 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryHandle.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryHandle.java
@@ -219,7 +219,7 @@ public interface RepositoryHandle {
* Perform a checkout on the specified item.
* @param parentPath parent folder path
* @param itemName name of item
- * @param CheckoutType checkout type. If exclusive or transient, checkout is only successful
+ * @param checkoutType checkout type. If exclusive or transient, checkout is only successful
* if no other checkouts exist. No new checkouts of item will be permitted while an
* exclusive/transient checkout is active.
* @param projectPath path of user's project
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryItem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryItem.java
index c6828d0cbe..6b02a52d2b 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryItem.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryItem.java
@@ -52,7 +52,6 @@ public class RepositoryItem implements java.io.Serializable {
* @param contentType content type associated with item
* @param version repository item version or -1 if versioning not supported
* @param versionTime version creation time
- * @param checkoutList list of checkouts for the associated repository item.
*/
public RepositoryItem(String folderPath, String itemName, String fileID, int itemType,
String contentType, int version, long versionTime) {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryServerHandle.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryServerHandle.java
index 287f50cf14..abbd8fb831 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryServerHandle.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryServerHandle.java
@@ -26,14 +26,14 @@ import ghidra.util.exception.UserAccessException;
public interface RepositoryServerHandle {
/**
- * @returns true if server allows anonymous access.
+ * @return true if server allows anonymous access.
* Individual repositories must grant anonymous access separately.
* @throws IOException if an IO error occurs
*/
boolean anonymousAccessAllowed() throws IOException;
/**
- * @returns true if user has restricted read-only access to server (e.g., anonymous user)
+ * @return true if user has restricted read-only access to server (e.g., anonymous user)
* @throws IOException if an IO error occurs
*/
boolean isReadOnly() throws IOException;
@@ -102,9 +102,9 @@ public interface RepositoryServerHandle {
/**
* Set the password for the user.
* @param saltedSHA256PasswordHash SHA256 salted password hash
- * @returns true if password changed
+ * @return true if password changed
* @throws IOException if an IO error occurs
- * @see HashUtilities#getSaltedHash("SHA-256", char[])
+ * @see ghidra.util.HashUtilities#getSaltedHash(String, char[]) HashUtilities.getSaltedHash("SHA-256", char[])
*/
boolean setPassword(char[] saltedSHA256PasswordHash) throws IOException;
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/SSHSignatureCallback.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/SSHSignatureCallback.java
index 3a9e863e89..f21f6e0d64 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/SSHSignatureCallback.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/SSHSignatureCallback.java
@@ -52,28 +52,28 @@ public class SSHSignatureCallback implements Callback, Serializable {
}
/**
- * @returns token to be signed using user certificate.
+ * @return token to be signed using user certificate.
*/
public byte[] getToken() {
return (token == null ? null : (byte[]) token.clone());
}
/**
- * @returns signed token bytes set by callback handler.
+ * @return signed token bytes set by callback handler.
*/
public byte[] getSignature() {
return (signature == null ? null : (byte[]) signature.clone());
}
/**
- * @returns the server's signature of the token bytes.
+ * @return the server's signature of the token bytes.
*/
public byte[] getServerSignature() {
return serverSignature;
}
/**
- * @returns true if callback has been signed
+ * @return true if callback has been signed
*/
public boolean isSigned() {
return signature != null;
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/DataFileHandle.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/DataFileHandle.java
index 46f7a1f069..9022b4b96b 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/DataFileHandle.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/DataFileHandle.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,7 +36,7 @@ public interface DataFileHandle {
* read, the end of the stream is detected, or an exception is thrown.
*
* @param b the buffer into which the data is read.
- * @exception EOFException if this file reaches the end before reading
+ * @exception java.io.EOFException if this file reaches the end before reading
* all the bytes.
* @exception IOException if an I/O error occurs.
*/
@@ -53,7 +52,7 @@ public interface DataFileHandle {
* @param b the buffer into which the data is read.
* @param off the start offset of the data.
* @param len the number of bytes to read.
- * @exception EOFException if this file reaches the end before reading
+ * @exception java.io.EOFException if this file reaches the end before reading
* all the bytes.
* @exception IOException if an I/O error occurs.
*/
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java
index 6db0208eef..6db3bc7b8c 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java
@@ -143,7 +143,6 @@ public interface FileSystem {
* @param parentPath folder path of parent
* @param name new database name
* @param fileID file ID to be associated with new database or null
- * @param bufferFile data source
* @param contentType application defined content type
* @param bufferSize buffer size. If copying an existing BufferFile, the buffer
* size must be the same as the source file.
@@ -164,7 +163,7 @@ public interface FileSystem {
* Creates a new empty data file within the specified parent folder.
* @param parentPath folder path of parent
* @param name new data file name
- * @param inputStream source data
+ * @param istream source data
* @param comment version comment (used for versioned file system only)
* @param contentType application defined content type
* @param monitor progress monitor (used for cancel support,
@@ -286,7 +285,7 @@ public interface FileSystem {
public boolean isShared();
/**
- * Cleanup & release resources
+ * Cleanup and release resources
*/
public void dispose();
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListener.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListener.java
index 2d602fff80..867dafff66 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListener.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListener.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -70,14 +69,14 @@ public interface FileSystemListener {
* Notification that an item was renamed.
* @param folderPath the path of the folder that contains the renamed item
* @param oldItemName the old name of the item.
- * @param newITemName the new name of the item.
+ * @param newItemName the new name of the item.
*/
void itemRenamed(String folderPath, String oldItemName, String newItemName);
/**
* Notification that an item was moved.
* @param parentPath the path of the folder that used to contain the item.
- * @param itemName the name of the item that was moved.
+ * @param name the name of the item that was moved.
* @param newParentPath the path of the folder that the item was moved to.
* @param newName the new name of the item.
*/
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListenerList.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListenerList.java
index 1c1cdf9107..b75d6e8992 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListenerList.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystemListenerList.java
@@ -39,7 +39,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Construct FileSystemListenerList
- * @param enableAsyncronousDispatching if true a seperate dispatch thread will be used
+ * @param enableAsynchronousDispatching if true a seperate dispatch thread will be used
* to notify listeners. If false, blocking notification will be performed.
*/
public FileSystemListenerList(boolean enableAsynchronousDispatching) {
@@ -83,7 +83,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards itemMoved callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#itemMoved(java.lang.String, java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#itemMoved(String, String, String, String)
*/
@Override
public void itemMoved(String parentPath, String name, String newParentPath, String newName) {
@@ -99,7 +99,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards itemRenamed callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#itemRenamed(java.lang.String, java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#itemRenamed(String, String, String)
*/
@Override
public void itemRenamed(String parentPath, String itemName, String newName) {
@@ -115,7 +115,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards itemDeleted callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#itemDeleted(java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#itemDeleted(String, String)
*/
@Override
public void itemDeleted(String parentPath, String itemName) {
@@ -131,7 +131,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards folderRenamed callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#folderRenamed(java.lang.String, java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#folderRenamed(String, String, String)
*/
@Override
public void folderRenamed(String parentPath, String folderName, String newFolderName) {
@@ -147,7 +147,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards folderMoved callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#folderMoved(java.lang.String, java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#folderMoved(String, String, String)
*/
@Override
public void folderMoved(String parentPath, String folderName, String newParentPath) {
@@ -163,7 +163,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards folderDeleted callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#folderDeleted(java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#folderDeleted(String, String)
*/
@Override
public void folderDeleted(String parentPath, String folderName) {
@@ -179,7 +179,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards itemCreated callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#itemCreated(java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#itemCreated(String, String)
*/
@Override
public void itemCreated(String parentPath, String itemName) {
@@ -195,7 +195,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards folderCreated callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#folderCreated(java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#folderCreated(String, String)
*/
@Override
public void folderCreated(String parentPath, String folderName) {
@@ -211,7 +211,7 @@ public class FileSystemListenerList implements FileSystemListener {
/**
* Forwards itemChanged callback to all listeners within this list.
- * @see ghidra.framework.store.FileSystemListener#itemChanged(java.lang.String, java.lang.String)
+ * @see ghidra.framework.store.FileSystemListener#itemChanged(String, String)
*/
@Override
public void itemChanged(String parentPath, String itemName) {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FolderItem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FolderItem.java
index 2ae29fd26e..1b446ac5a5 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FolderItem.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FolderItem.java
@@ -258,9 +258,7 @@ public interface FolderItem {
/**
* Get all current checkouts for this item.
- * @param parentPath
- * @param itemName
- * @return list of checkouts
+ * @return array of checkouts
* @throws IOException if an IO error occurs or this item is not versioned
*/
ItemCheckoutStatus[] getCheckouts() throws IOException;
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDBHandle.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDBHandle.java
index 56a9583858..49ea1afae6 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDBHandle.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDBHandle.java
@@ -60,9 +60,6 @@ public class PackedDBHandle extends DBHandle {
this.contentType = pdb.getContentType();
}
- /*
- * @see ghidra.framework.store.db.DBHandle#save(java.lang.String, ghidra.framework.model.ChangeSet, ghidra.util.task.TaskMonitor)
- */
@Override
public synchronized void save(String comment, DBChangeSet changeSet, TaskMonitor monitor)
throws IOException, CancelledException {
@@ -125,7 +122,6 @@ public class PackedDBHandle extends DBHandle {
* @throws CancelledException if task monitor cancelled operation.
* @throws IOException
* @throws DuplicateFileException
- * @see db.DBHandle#saveAs(java.io.File, java.lang.String, ghidra.util.task.TaskMonitor)
*/
public synchronized PackedDatabase saveAs(String itemName, File dir, String packedFileName,
TaskMonitor monitor) throws IOException, DuplicateFileException, CancelledException {
@@ -154,7 +150,6 @@ public class PackedDBHandle extends DBHandle {
* @throws CancelledException if task monitor cancelled operation.
* @throws IOException
* @throws DuplicateFileException
- * @see db.DBHandle#saveAs(java.io.File, java.lang.String, ghidra.util.task.TaskMonitor)
*/
public synchronized PackedDatabase saveAs(String itemName, File dir, String packedFileName,
Long newDatabaseId, TaskMonitor monitor)
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDatabase.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDatabase.java
index b9cf8bad92..41bfd8c7bf 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDatabase.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PackedDatabase.java
@@ -493,11 +493,10 @@ public class PackedDatabase extends Database {
/**
* Create a new Database with data provided by an ItemDeserializer.
- * @param dir the parent directory which contains the "Hidden" database directory.
- * @param dbName the unmangled database name
- * @param checkinId
- * @param packedFile
- * @param monitor
+ * @param bfMgr the buffer manager for the database
+ * @param checkinId the check-in id
+ * @param packedFile the file to unpack
+ * @param monitor the task monitor
* @throws CancelledException
*/
public static void unpackDatabase(BufferFileManager bfMgr, long checkinId, File packedFile,
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PrivateDatabase.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PrivateDatabase.java
index 99ed5b1821..372b9411f6 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PrivateDatabase.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/db/PrivateDatabase.java
@@ -154,11 +154,8 @@ public class PrivateDatabase extends Database {
/**
* Open the current version of this database for update use.
- * @param recover if true an attempt will be made to recover unsaved changes
- * from a previous crash.
- * @param monitor task monitor
* @return updateable buffer file
- * @throws IOException
+ * @throws IOException if updating this database file is not allowed
*/
public LocalManagedBufferFile openBufferFileForUpdate() throws IOException {
if (!updateAllowed) {
@@ -181,7 +178,8 @@ public class PrivateDatabase extends Database {
* Following a move of the database directory,
* this method should be invoked if this instance will
* continue to be used.
- * @param dirir new database directory
+ * @param dir new database directory
+ * @throws FileNotFoundException if the database directory cannot be found
*/
public void dbMoved(File dir) throws FileNotFoundException {
synchronized (syncObject) {
@@ -246,7 +244,7 @@ public class PrivateDatabase extends Database {
* If already open for update, a save should not be done or the database
* may become corrupted. All existing handles should be closed and reopened
* when this method is complete.
- * @param privateDb
+ * @param otherDb the other database.
* @throws IOException if an IO error occurs. An attempt will be made to restore
* this database to its original state, however the otherDb will not be repaired
* and may become unusable.
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/FileChangeListener.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/FileChangeListener.java
index 1182b58fdf..6deeb0b70a 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/FileChangeListener.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/FileChangeListener.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,8 +30,6 @@ public interface FileChangeListener {
* on behalf of the caller. This method should not attempt to alter the
* lock.
* @param file the modified file.
- * @param haveLock is true if a file lock has been granted (LockFile was
- * supplied at time of construction).
*/
public void fileModified(File file);
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemDeserializer.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemDeserializer.java
index 1976e3f72f..4499c350d2 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemDeserializer.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemDeserializer.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -54,8 +53,7 @@ public class ItemDeserializer {
/**
* Constructor.
- * @param in input stream. The input stream must not be read again until
- * after the saveItem method has been invoked successfully.
+ * @param packedFile item to deserialize.
* @throws IOException
*/
public ItemDeserializer(File packedFile) throws IOException {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemSerializer.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemSerializer.java
index 5e0bf26d2c..0d70420826 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemSerializer.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/ItemSerializer.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -162,7 +161,7 @@ public class ItemSerializer {
* @param inputStream a stream for accessing bytes of what may be a packed file
* @return true if the bytes from the inputStream represent the bytes of a packed file
* @throws IOException If there is a problem accessing the inputStream
- * @see {@link #isPackedFile(File)}
+ * @see #isPackedFile(File)
*/
public static boolean isPackedFile(InputStream inputStream) throws IOException {
inputStream.skip(MAGIC_NUMBER_POS);
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalDataFile.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalDataFile.java
index a790a8cc33..7778c9f8b2 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalDataFile.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalDataFile.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -121,16 +120,12 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
return new File(getDataDir(), DATA_FILE);
}
- /**
- * @see ghidra.framework.store.DataFile#getInputStream()
- */
+ @Override
public InputStream getInputStream() throws FileNotFoundException {
return new FileInputStream(getDataFile());
}
- /**
- * @see ghidra.framework.store.DataFileItem#getInputStream(int)
- */
+ @Override
public InputStream getInputStream(int version) throws FileNotFoundException {
// TODO Versions for DataFiles are not supported
@@ -138,16 +133,11 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
return new FileInputStream(getDataFile());
}
- /**
- * @see ghidra.framework.store.DataFile#getOutputStream()
- */
+ @Override
public OutputStream getOutputStream() throws FileNotFoundException {
return new FileOutputStream(getDataFile());
}
- /*
- * @see ghidra.framework.store.FolderItem#updateCheckout(ghidra.framework.store.FolderItem, boolean, ghidra.util.task.TaskMonitor)
- */
@Override
public void updateCheckout(FolderItem versionedFolderItem, boolean updateItem,
TaskMonitor monitor) throws IOException {
@@ -156,9 +146,6 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
}
- /*
- * @see ghidra.framework.store.FolderItem#updateCheckout(ghidra.framework.store.FolderItem, int)
- */
@Override
public void updateCheckout(FolderItem item, int checkoutVersion) throws IOException {
@@ -166,9 +153,6 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
}
- /*
- * @see ghidra.framework.store.local.LocalFolderItem#deleteMinimumVersion(java.lang.String)
- */
@Override
void deleteMinimumVersion(String user) throws IOException {
@@ -176,9 +160,6 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
}
- /*
- * @see ghidra.framework.store.local.LocalFolderItem#deleteCurrentVersion(java.lang.String)
- */
@Override
void deleteCurrentVersion(String user) throws IOException {
@@ -186,33 +167,24 @@ public class LocalDataFile extends LocalFolderItem implements DataFileItem {
}
- /*
- * @see ghidra.framework.store.FolderItem#output(java.io.File, int, ghidra.util.task.TaskMonitor)
- */
+ @Override
public void output(File outputFile, int version, TaskMonitor monitor) throws IOException {
throw new UnsupportedOperationException("Output not yet supported for DataFiles");
}
- /*
- * @see ghidra.framework.store.local.LocalFolderItem#getMinimumVersion()
- */
@Override
int getMinimumVersion() throws IOException {
return -1;
}
- /*
- * @see ghidra.framework.store.FolderItem#getCurrentVersion()
- */
+ @Override
public int getCurrentVersion() {
return -1;
}
- /*
- * @see ghidra.framework.store.FolderItem#canRecover()
- */
+ @Override
public boolean canRecover() {
return false;
}
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalFileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalFileSystem.java
index 41e2f7fee0..c8bf0d68d5 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalFileSystem.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LocalFileSystem.java
@@ -53,7 +53,7 @@ public abstract class LocalFileSystem implements FileSystem {
/**
* Hidden directory name prefix.
* Should only be prepended to an escaped base-name.
- * @see #escapeHiddenPrefixChars(String)
+ * @see #escapeHiddenDirPrefixChars(String)
*/
public static final char HIDDEN_DIR_PREFIX_CHAR = '~';
public static final String HIDDEN_DIR_PREFIX = Character.toString(HIDDEN_DIR_PREFIX_CHAR);
@@ -169,7 +169,7 @@ public abstract class LocalFileSystem implements FileSystem {
/**
* Constructor.
- * @param file path path for root directory.
+ * @param rootPath root path directory.
* @param isVersioned if true item versioning will be enabled.
* @param readOnly if true modifications within this file-system will not be allowed
* and result in an ReadOnlyException
@@ -273,14 +273,13 @@ public abstract class LocalFileSystem implements FileSystem {
* significant performance impact. This does not provide locking which may be
* required for a shared environment (e.g., checkin locking is only managed by a
* single instance).
- * @param validationRequired
*/
public static void setValidationRequired() {
refreshRequired = true;
}
/**
- * @returns true if folder item resources must be refreshed.
+ * @return true if folder item resources must be refreshed.
* @see #setValidationRequired()
*/
public static boolean isRefreshRequired() {
@@ -699,7 +698,7 @@ public abstract class LocalFileSystem implements FileSystem {
}
/**
- * @returns the maximum name length permitted for folders or items.
+ * @return the maximum name length permitted for folders or items.
*/
public abstract int getMaxNameLength();
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LockFile.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LockFile.java
index 40cd2edcf1..6e40ad3a77 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LockFile.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/local/LockFile.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -239,7 +238,7 @@ public class LockFile {
/**
* Return the name of the current lock owner
- * or "" if not locked or could not be determined.
+ * or {@code ""} if not locked or could not be determined.
*/
public String getLockOwner() {
return getLockOwner(false);
@@ -346,7 +345,6 @@ public class LockFile {
/**
* Create the lock file using the default timeout.
* Lock is guaranteed for MAX_LOCK_LEASE_PERIOD seconds.
- * @param timeout maximum time in seconds to wait for lock.
* @return true if lock creation was successful.
*/
public boolean createLock() {
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteFileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteFileSystem.java
index 447b9d127d..a19cb2d84b 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteFileSystem.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteFileSystem.java
@@ -46,7 +46,6 @@ public class RemoteFileSystem implements FileSystem, RemoteAdapterListener {
/**
* Construct a new remote file system which corresponds to a remote repository.
* @param repository remote Repository
- * @throws IOException
*/
public RemoteFileSystem(RepositoryAdapter repository) {
this.repository = repository;
diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/util/PropertyFile.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/util/PropertyFile.java
index 8a04fd7d4c..85079a383e 100644
--- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/util/PropertyFile.java
+++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/util/PropertyFile.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -147,7 +146,7 @@ public class PropertyFile {
/**
* Returns the FileID associated with this file.
- * @returns FileID associated with this file
+ * @return FileID associated with this file
*/
public String getFileID() {
return getString(FILE_ID, null);
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/algorithms/ReducingListBasedLcs.java b/Ghidra/Framework/Generic/src/main/java/generic/algorithms/ReducingListBasedLcs.java
index 57cac9b43c..664f94ff33 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/algorithms/ReducingListBasedLcs.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/algorithms/ReducingListBasedLcs.java
@@ -18,7 +18,7 @@ package generic.algorithms;
import java.util.List;
/**
- * An implementation of the {@link ReducingLcs} that takes as its input a list of items, where
+ * An implementation of the {@link ReducingLcs} that takes as its input a list of {@literal }items, where
* the list is the 'sequence' being checked for the Longest Common Subsequence.
*
* @param the type of the item in the sequence of items
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 12a6b2e892..8c4e32c930 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java
@@ -35,7 +35,7 @@ import ghidra.util.task.TaskMonitor;
*
*
* Put and Forget:
- *
+ * {@literal
* QCallback callback = new AbstractQCallback() {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
@@ -49,11 +49,11 @@ import ghidra.util.task.TaskMonitor;
* ...
* concurrentQ.add(item); // where item is one of the instances of ITEM
*
- *
+ * }
*
*
* Put Items and Handle Results in Any Order as They Available:
- *
+ * {@literal
* QCallback callback = new AbstractQCallback() {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
@@ -62,14 +62,14 @@ import ghidra.util.task.TaskMonitor;
*
* QItemListener itemListener = new QItemListener() {
* public void itemProcessed(QResult result) {
- * RESULT result = result.getResult();
- * // work on my result...
+ * RESULT result = result.getResult();}
+ * // work on my result...{@code
* }
* };
*
* ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * builder.setListener(itemListener);
+ * }builder.setListener(itemListener);{@code
* concurrentQ = builder.build(callback);
* ...
* ...
@@ -77,12 +77,12 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
*
- *
+ * }
*
*
*
* Put Items and Handle Results When All Items Have Been Processed:
- *
+ * {@literal
* QCallback callback = new AbstractQCallback() {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
@@ -91,7 +91,7 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * builder.setCollectResults(true);
+ * }builder.setCollectResults(true);{@code
* concurrentQ = builder.getQueue(callback);
* ...
* ...
@@ -99,14 +99,14 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item);
* concurrentQ.add(item);
* ...
- * List<QResult<I, R>> results = concurrentQ.waitForResults();
+ * }{@literal List> results = concurrentQ.waitForResults();}{@literal
* // process the results...
*
- *
+ * }
*
*
* Put Items, Blocking While Full, and Handle Results in Any Order as They Available:
- *
+ * {@literal
* QCallback callback = new AbstractQCallback() {
* public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here...
@@ -122,12 +122,12 @@ import ghidra.util.task.TaskMonitor;
*
* ConcurrentQBuilder builder = new ConcurrentQBuilder();
* builder.setThreadPoolName("Thread Pool Name");
- * builder.setQueue(new LinkedBlockingQueue(100));
+ * }builder.setQueue(new LinkedBlockingQueue(100));{@literal
* concurrentQ = builder.getQueue(callback);
* ...
* ...
- * Iterator- iterator = <get an iterator for 1000s of items somewhere>
- * concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)
+ * Iterator
- iterator =
+ * }{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}
*
*
*
@@ -378,7 +378,7 @@ public class ConcurrentQ {
*
* @return the first available result
* @throws InterruptedException if interrupted while waiting for a result
- * @throws {@link IllegalStateException} if this queue has been set to not collect results
+ * @throws IllegalStateException if this queue has been set to not collect results
* (see the constructor).
*/
public QResult waitForNextResult() throws InterruptedException {
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 678c9af52e..c060a2e6a5 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQBuilder.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -34,7 +33,7 @@ import java.util.concurrent.LinkedBlockingQueue;
*
* Examples:
*
- *
+ * {@literal
* QCallback callback = new AbstractQCallback() {
* public R process(I item, TaskMonitor monitor) {
* // do work here...
@@ -53,7 +52,7 @@ import java.util.concurrent.LinkedBlockingQueue;
* setMaxInProgress(1).
* build(callback);
*
- *
+ * }
*
*
* Note: if you wish to take advantage of blocking when adding items to the {@link ConcurrentQ},
@@ -180,7 +179,7 @@ public class ConcurrentQBuilder {
}
/**
- * @see {@link ConcurrentQ#setMonitor(TaskMonitor, boolean)}
+ * @see ConcurrentQ#setMonitor(TaskMonitor, boolean)
*
* The default value is true.
*/
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 b0af02b425..2beb20a9fa 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QCallback.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,13 +19,13 @@ import ghidra.util.task.TaskMonitor;
/**
* Interface that defines the callback to work on the items given to the
- * {@link ConcurrentQ#add(I)} methods. Each item that is processed will be handed to the
- * {@link #process(I, TaskMonitor)} method of the implementing class.
+ * {@link ConcurrentQ#add(Object) ConcurrentQ.add(I)} methods. Each item that is processed will be handed to the
+ * {@link #process(Object, TaskMonitor) process(I, TaskMonitor)} method of the implementing class.
*
* @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
- * same value as {@link I} and return null from {@link #process(Object, TaskMonitor)}.
+ * 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/concurrent/QProgressListener.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QProgressListener.java
index a75f3286fa..5cbeb61ec4 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QProgressListener.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QProgressListener.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,18 +25,17 @@ public interface QProgressListener {
* Notification that progress has changed during the processing of an item.
* @param id the id of the item being processed. Since multiple items can be processed concurrently,
* the id can be used to "demultiplex" the progress and messages being generated.
- * @param currentProgress the current value of the progress for this task.
- * @param progressMessage the last message set for this task.s
* @param item the item that was being processed when the worker changed the max progress.
+ * @param currentProgress the current value of the progress for this task.
*/
- void progressChanged(long id, I Item, long currentProgress);
+ void progressChanged(long id, I item, long currentProgress);
/**
* Notification that a new task has been generated to process an item.
* @param id the id of the item being processed.
* @param item the item that was being processed when the worker changed the max progress.
*/
- void taskStarted(long id, I Item);
+ void taskStarted(long id, I item);
/**
* Notification that a new task has completed processing for an item.
@@ -46,7 +44,7 @@ public interface QProgressListener {
* @param totalCount the total number of items that have been submitted to the ConcurrentQ
* @param completedCount the total number of items that completed processing.
*/
- void taskEnded(long id, I Item, long totalCount, long completedCount);
+ void taskEnded(long id, I item, long totalCount, long completedCount);
/**
* Notification that the progress mode has changed from/to indeterminate mode
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QRunnable.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QRunnable.java
index e5c7c690a7..aae2525516 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QRunnable.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/QRunnable.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,8 +19,8 @@ import ghidra.util.task.TaskMonitor;
/**
* Interface that defines the Runnable to work on the items given to the
- * {@link ConcurrentQ#add(I)} methods. Each item that is processed will be handed to the
- * {@link #run(I, TaskMonitor)} method of the implementing class.
+ * {@link ConcurrentQ#add(Object) ConcurrentQ.add(I)} methods. Each item that is processed will be handed to the
+ * {@link #run(Object, TaskMonitor) run(I, TaskMonitor)} method of the implementing class.
*
* @param The type of the items to be processed.
*/
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/constraint/Constraint.java b/Ghidra/Framework/Generic/src/main/java/generic/constraint/Constraint.java
index 0153e09015..64587ab971 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/constraint/Constraint.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/constraint/Constraint.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -46,7 +45,7 @@ public abstract class Constraint {
/**
* Returns true if the given object satisfies this constraint.
- * @param the object to test this constraint on.
+ * @param t the object to test this constraint on.
* @return true if the given object satisfies this constraint.
*/
public abstract boolean isSatisfied(T t);
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/json/JSONToken.java b/Ghidra/Framework/Generic/src/main/java/generic/json/JSONToken.java
index db0f899ecf..879ff4969c 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/json/JSONToken.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/json/JSONToken.java
@@ -4,19 +4,18 @@
package generic.json;
public class JSONToken {
-
- /**
- * JSON token description.
- * @param type type (object, array, string etc.)
- * @param start start position in JSON data string
- * @param end end position in JSON data string
- */
public JSONType type;
public int start;
public int end;
public int size;
-
+
+ /**
+ * JSON token description.
+ * @param type the token type (object, array, string etc.)
+ * @param start the start position in JSON data string
+ * @param end the end position in JSON data string
+ */
public JSONToken(JSONType type, int start, int end) {
setType(type);
setStart(start);
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHCosineVector.java b/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHCosineVector.java
index 34b16d121b..2b603922e5 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHCosineVector.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHCosineVector.java
@@ -38,7 +38,7 @@ public class LSHCosineVector implements LSHVector {
/**
* Install a set of features as an int[]. Each integer is a hash. The integers MUST already be sorted.
- * The same integer can occur more than once in the array (term frequency (TF) > 1).
+ * The same integer can occur more than once in the array (term frequency (TF) > 1).
* Weights are determined by TF and Inverse Document Frequency (IDF) of individual features
* @param feature is the sorted array of integer hashes
* @param wfactory is the container of weighting information
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHVectorFactory.java b/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHVectorFactory.java
index be9757f630..ed81f7feaa 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHVectorFactory.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/lsh/vector/LSHVectorFactory.java
@@ -36,7 +36,7 @@ public abstract class LSHVectorFactory {
/**
* Generate an LSHVector from a feature set, individual features are integer hashes.
* The integers MUST already be sorted.
- * The same integer can occur more than once in the array (term frequency (TF) > 1).
+ * The same integer can occur more than once in the array (term frequency (TF) > 1).
* The factory decides internally how to create weights based on term frequency and any
* knowledge of Inverse Document Frequency (IDF)
* @param feature is the sorted array of integer features
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/stl/RedBlackTree.java b/Ghidra/Framework/Generic/src/main/java/generic/stl/RedBlackTree.java
index 32add1019c..2b4541b9ea 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/stl/RedBlackTree.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/stl/RedBlackTree.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,14 +36,19 @@ public class RedBlackTree {
private final boolean allowDuplicateKeys;
/**
- * Creates a new RedBlackKeySet that can store keys between 0 and n.
- * @param n the maximum key for this set.
+ * Creates a new RedBlackTree
+ * @param comparator the comparator for this tree
+ * @param allowDuplicateKeys true to allow duplicate keys
*/
public RedBlackTree(Comparator comparator, boolean allowDuplicateKeys) {
this.comparator = comparator;
this.allowDuplicateKeys = allowDuplicateKeys;
}
+ /**
+ * Creates a copy of an existing RedBlackTree
+ * @param tree the existing tree to copy
+ */
public RedBlackTree(RedBlackTree tree) {
this.comparator = tree.comparator;
this.allowDuplicateKeys = tree.allowDuplicateKeys;
@@ -129,10 +133,10 @@ public class RedBlackTree {
}
/**
- * Finds the node with the lowest key that is >= to the given key. Returns null if all nodes
+ * Finds the node with the lowest key that is >= to the given key. Returns null if all nodes
* in the tree have keys less than the given key.
* @param key the key to search for.
- * @return the node with the lowest key that is >= to the given key or null if no such key exists.
+ * @return the node with the lowest key that is >= to the given key or null if no such key exists.
*/
public RedBlackNode lowerBound(K key) {
RedBlackNode bestNode = null;
@@ -154,10 +158,10 @@ public class RedBlackTree {
/**
- * Finds the node with the lowest key that is > the given key. Returns null if all nodes
+ * Finds the node with the lowest key that is > the given key. Returns null if all nodes
* in the tree have keys less than or equal to the given key.
* @param key the key to search for.
- * @return the node with the lowest key that is > to the given key or null if no such key exists.
+ * @return the node with the lowest key that is > to the given key or null if no such key exists.
*/
public RedBlackNode upperBound(K key){
RedBlackNode bestNode = null;
@@ -183,6 +187,7 @@ public class RedBlackTree {
* already exists, the old value will be replaced by the new value and the old value will be
* returned.
* @param key the key to add to the set.
+ * @param value the key's value.
* @return the old value associated with the key, or null if the key was not previously in the map.
*/
public Pair, Boolean> put(K key, V value) {
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 61b0740ef8..309361971d 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/test/AbstractGenericTest.java
@@ -15,7 +15,7 @@
*/
package generic.test;
-import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.*;
import java.awt.*;
import java.awt.event.*;
@@ -1482,7 +1482,7 @@ public abstract class AbstractGenericTest extends AbstractGTest {
/**
* Invoke fixupGUI at the beginning of your JUnit test or in
* its setup() method to make your GUI for the JUnit test appear using the
- * system Look & Feel. The system look and feel is the default that Ghidra
+ * system Look and Feel. The system look and feel is the default that Ghidra
* uses. This will also change the default fonts for the JUnit test to be
* the same as those in Ghidra.
*
diff --git a/Ghidra/Framework/Generic/src/main/java/generic/timer/GhidraSwinglessTimer.java b/Ghidra/Framework/Generic/src/main/java/generic/timer/GhidraSwinglessTimer.java
index 2d44c653a0..67472ad139 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/timer/GhidraSwinglessTimer.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/timer/GhidraSwinglessTimer.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -92,7 +91,7 @@ public class GhidraSwinglessTimer implements GhidraTimer {
/**
* Creates a new repeating timer with a initial and continual delay with the given delay.
* @param delay the delay to use for the first and subsequent timer callbacks.
- * @callback the callback the be called with the timer fires.
+ * @param callback the callback the be called with the timer fires.
*/
public GhidraSwinglessTimer(int delay, TimerCallback callback) {
this(delay,delay,callback);
@@ -102,7 +101,7 @@ public class GhidraSwinglessTimer implements GhidraTimer {
* Creates a new repeating timer with an initial and continual delay.
* @param initialDelay the delay to use for the first timer callbacks.
* @param delay the delay to use for subsequent timer callbacks.
- * @callback the callback the be called with the timer fires.
+ * @param callback the callback the be called with the timer fires.
*/
public GhidraSwinglessTimer(int initialDelay, int delay, TimerCallback callback) {
this.callback = callback;
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 fc078fb82c..85da8d8dbc 100644
--- a/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
+++ b/Ghidra/Framework/Generic/src/main/java/generic/util/MultiIterator.java
@@ -43,7 +43,7 @@ public class MultiIterator implements Iterator {
* Use this constructor when the items of the iterators are naturally comparable (i.e.,
* they implement {@link Comparable}).
*
- * @param comparator the comparator used to find the next item
+ * @param iterators the iterators that provide the data
* @param forward true if the iterators provide data sorted ascending; false for descending
*/
public MultiIterator(List> iterators, boolean forward) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/SwingExceptionHandler.java b/Ghidra/Framework/Generic/src/main/java/ghidra/SwingExceptionHandler.java
index 14471deab4..40ce8a5d9b 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/SwingExceptionHandler.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/SwingExceptionHandler.java
@@ -29,10 +29,9 @@ import ghidra.util.exception.ClosedException;
public class SwingExceptionHandler implements UncaughtExceptionHandler {
/**
- * Handle exception caught within the EventDispatchThread.
+ * Handle exception caught within the Swing event dispatch thread.
* @param t exception
* @throws Throwable error occurred while attempting to handle exception
- * @see java.awt.EventDispatchThread#handleException(java.lang.Throwable)
*/
public void handle(Throwable t) throws Throwable {
handleUncaughtException(t);
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 6648dadba9..7199d4947e 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java
@@ -804,7 +804,7 @@ public class Application {
/**
* Returns a list of all directories in any module that have the given module relative path. For
* example, a relative path of "foo/bar" will return all directories that are of the form
- * /data/foo/bar
+ * {@code /data/foo/bar}
* @param relativePath the module relative path to search for.
* @return a list of all directories in any module that have the given module relative path.
*/
@@ -890,7 +890,7 @@ public class Application {
/**
* Returns the file relative to the named module's directory.
* @param moduleName the name of the module.
- * @param relativeDataPath the path relative to the module's data directory.
+ * @param relativePath the path relative to the module's data directory.
* @throws FileNotFoundException if the file does not exist.
*/
public static ResourceFile getModuleFile(String moduleName, String relativePath)
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ModuleInitializer.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ModuleInitializer.java
index 0d044cdae1..01bbe7f66d 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ModuleInitializer.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ModuleInitializer.java
@@ -36,7 +36,7 @@ public interface ModuleInitializer
//@formatter:on
/**
- * @returns initializer name
+ * @return initializer name
*/
public String getName();
}
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ShutdownHookRegistry.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ShutdownHookRegistry.java
index b05e17fe58..13f0394535 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ShutdownHookRegistry.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/ShutdownHookRegistry.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -45,8 +44,7 @@ public class ShutdownHookRegistry {
/**
* Remove a shutdown hook previously registered.
* Hooks with a higher priority value will run first
- * @param r shutdown hook runnable
- * @param priority relative priority
+ * @param hook shutdown hook
*/
public static synchronized void removeShutdownHook(ShutdownHook hook) {
hooks.remove(hook);
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/Options.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/Options.java
index 1c8795a4ea..21066e45ee 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/Options.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/Options.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -59,7 +58,7 @@ public interface Options {
* from the swing thread.
* @return either the PropertyEditor that was registered for this option or a default editor
* for the property type if one can be found; otherwise null.
- * @throw IllegalStateException if not called from the swing thread.
+ * @throws IllegalStateException if not called from the swing thread.
*/
public PropertyEditor getPropertyEditor(String optionName);
@@ -112,7 +111,7 @@ public interface Options {
* @param optionName the name of the option being registered.
* @param defaultValue the defaultValue for the option. The default value must not be
* null so that the OptionType can be determined. If the default value should be null, use
- * {@link #registerOption(String, OptionType, Object, HelpLocation, String)
+ * {@link #registerOption(String, OptionType, Object, HelpLocation, String)}
* @param help the HelpLocation for this option.
* @param description a description of the option.
* @throws IllegalArgumentException if the defaultValue is null
@@ -151,15 +150,13 @@ public interface Options {
/**
* Register the options editor that will handle the editing for all the options or a sub group of options.
- * @param path the path to the sub group of options or "" for all the options.
* @param editor the custom editor panel to be used to edit the options or sub group of options.
*/
public abstract void registerOptionsEditor(OptionsEditor editor);
/**
* Get the editor that will handle editing all the values in this options or sub group of options.
- * @param path the path to the sub group of options or "" for all the options.
- * @return null if no options editor was registered
+ * @return null if no options editor was registered
*/
public abstract OptionsEditor getOptionsEditor();
@@ -268,8 +265,8 @@ public interface Options {
/**
* Get the Date for the given option name.
- * @param optionName option name
- * @param defaultValue value that is stored and returned if there is no
+ * @param pName the property name
+ * @param date the default date that is stored and returned if there is no
* option with the given name
* @return the Date for the option
* @throws IllegalArgumentException is a option exists with the given
@@ -376,7 +373,7 @@ public interface Options {
/**
* Sets the Date value for the option.
* @param optionName name of the option
- * @param value
+ * @param newSetting the Date to set
*/
public abstract void setDate(String optionName, Date newSetting);
@@ -508,7 +505,7 @@ public interface Options {
/**
* Returns the value as a string for the given option.
- * @param optionName the name of the option for which to retrieve the value as a string
+ * @param name the name of the option for which to retrieve the value as a string
* @return the value as a string for the given option.
*/
public abstract String getValueAsString(String name);
@@ -518,6 +515,6 @@ public interface Options {
* @param optionName the name of the option for which to retrieve the default value as a string
* @return the default value as a string for the given option.
*/
- public abstract String getDefaultValueAsString(String analyzerName);
+ public abstract String getDefaultValueAsString(String optionName);
}
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/generic/util/datastruct/DynamicValueSortedTreeMap.java b/Ghidra/Framework/Generic/src/main/java/ghidra/generic/util/datastruct/DynamicValueSortedTreeMap.java
index 6d8655b021..69587aae63 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/generic/util/datastruct/DynamicValueSortedTreeMap.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/generic/util/datastruct/DynamicValueSortedTreeMap.java
@@ -28,7 +28,7 @@ import ghidra.util.ReversedListIterator;
* Such a tree may be useful as a priority queue where the cost of an entry may change over time.
* As such, the collections returned by {@link #entrySet()}, {@link #keySet()}, and
* {@link #values()} all implement {@link Deque}. The order of the entries will be updated on any
- * call to {@link #put(Object, Object))}, or a call to {@link Collection#add(Object)} on the entry
+ * call to {@link #put(Object, Object)}, or a call to {@link Collection#add(Object)} on the entry
* set. Additionally, if the values are mutable objects, whose costs may change, there is an
* {@link #update(Object)} method, which notifies the map that the given key may need to be
* repositioned. The associated collections also implement the {@link List} interface, providing
@@ -38,9 +38,9 @@ import ghidra.util.ReversedListIterator;
*
* The underlying implementation is currently an unbalanced binary tree whose nodes also comprise a
* doubly-linked list. Currently, it is not thread safe.
- * @TODO Consider changing to an AVL tree implementation
- * @TODO Consider implementing the {@link NavigableMap} interface
- * @TODO Consider making the implementation thread-safe
+ * TODO Consider changing to an AVL tree implementation
+ * TODO Consider implementing the {@link NavigableMap} interface
+ * TODO Consider making the implementation thread-safe
*
* @param the type of the keys
* @param the type of the values
@@ -340,7 +340,7 @@ public class DynamicValueSortedTreeMap extends AbstractMap {
/**
* Insert a node as a successor to this node in the linked list
- * @note Called only after the node is inserted into the tree
+ * NOTE: Called only after the node is inserted into the tree
*/
private void insertAfter(Node item) {
item.prev = this;
@@ -357,7 +357,7 @@ public class DynamicValueSortedTreeMap extends AbstractMap {
/**
* Insert a node as a predecessor to this node in the linked list
- * @note Called only after the node is inserted into the tree
+ * NOTE: Called only after the node is inserted into the tree
*/
private void insertBefore(Node item) {
item.prev = prev;
@@ -498,7 +498,7 @@ public class DynamicValueSortedTreeMap extends AbstractMap {
/**
* When searching for values, identifies which instance to find
*
- * @TODO When/if implementing {@link NavigableMap}, this seems an appropriate place to put
+ * TODO When/if implementing {@link NavigableMap}, this seems an appropriate place to put
* FLOOR, CEILING, etc.
*/
private enum SearchMode {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/net/ApplicationTrustManagerFactory.java b/Ghidra/Framework/Generic/src/main/java/ghidra/net/ApplicationTrustManagerFactory.java
index 072e21d900..0d7d700279 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/net/ApplicationTrustManagerFactory.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/net/ApplicationTrustManagerFactory.java
@@ -41,7 +41,7 @@ import ghidra.util.Msg;
* *.cer, *.der) or may be in a Java JKS form (*.jks). The path to this file may be
* established in one of two ways using the absolute file path:
*
- * - setting the system property ghidra.cacerts (takes precedence)
+ * setting the system property ghidra.cacerts (takes precedence)
* setting the user preference ghidra.cacerts
*
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/net/SSLContextInitializer.java b/Ghidra/Framework/Generic/src/main/java/ghidra/net/SSLContextInitializer.java
index 731185b03f..4bfc178c75 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/net/SSLContextInitializer.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/net/SSLContextInitializer.java
@@ -45,7 +45,7 @@ public class SSLContextInitializer implements ModuleInitializer {
/**
* Initialize default SSLContext with optional reset.
* This method is primarily intended for testing.
- * @param if true a complete reset will be done to force use of
+ * @param reset if true a complete reset will be done to force use of
* any new certificate or keystores previously used.
* @return true if successful, else false (see logged error)
*/
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java
index a73f1955fb..3f5b764463 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/DataConverter.java
@@ -134,7 +134,7 @@ public interface DataConverter extends Serializable {
* @param value value to convert to bytes
* @param b byte array to store bytes
* @param offset offset into byte array to put the bytes
- * @throws IndexOutOfBoundsException if (offset+2)>b.length
+ * @throws IndexOutOfBoundsException if (offset+2)>b.length
*/
public void getBytes(short value, byte[] b, int offset);
@@ -152,7 +152,7 @@ public interface DataConverter extends Serializable {
* @param value value to convert to bytes
* @param b byte array to store bytes
* @param offset offset into byte array to put the bytes
- * @throws IndexOutOfBoundsException if (offset+4)>b.length
+ * @throws IndexOutOfBoundsException if (offset+4)>b.length
*/
public void getBytes(int value, byte[] b, int offset);
@@ -170,7 +170,7 @@ public interface DataConverter extends Serializable {
* @param value value to convert to bytes
* @param b byte array to store bytes
* @param offset offset into byte array to put the bytes
- * @throws IndexOutOfBoundsException if (offset+8)>b.length
+ * @throws IndexOutOfBoundsException if (offset+8)>b.length
*/
public void getBytes(long value, byte[] b, int offset);
@@ -181,7 +181,7 @@ public interface DataConverter extends Serializable {
* @param size number of least significant bytes of value to be written to the byte array
* @param b byte array to store bytes
* @param offset offset into byte array to put the bytes
- * @throws IndexOutOfBoundsException if (offset+size)>b.length.
+ * @throws IndexOutOfBoundsException if (offset+size)>b.length.
*/
public void getBytes(long value, int size, byte[] b, int offset);
@@ -192,7 +192,7 @@ public interface DataConverter extends Serializable {
* @param size number of least significant bytes of value to be written to the byte array
* @param b byte array to store bytes
* @param offset offset into byte array to put the bytes
- * @throws IndexOutOfBoundsException if (offset+size)>b.length.
+ * @throws IndexOutOfBoundsException if (offset+size)>b.length.
*/
public void getBytes(BigInteger value, int size, byte[] b, int offset);
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 6a5a371ea0..2d68a46be0 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/NumericUtilities.java
@@ -242,7 +242,7 @@ public final class NumericUtilities {
/**
* Get an unsigned aligned value corresponding to the specified unsigned value
* which will be greater than or equal the specified value.
- * @param value value to be aligned
+ * @param unsignedValue value to be aligned
* @param alignment alignment
* @return aligned value
*/
@@ -270,7 +270,7 @@ public final class NumericUtilities {
*
* For example, consider the mask 00001111:01011100, and the value 00001001:00011000. This
* will display as {@code X8:[x0x1][10xx]}. To see the correlation, consider the table:
- *
+ *
* | Display | {@code X} | {@code 8} | {@code :} |
* {@code [x0x1]} | {@code [10xx]} |
|---|
* | Mask | {@code 0000} | {@code 1111} | {@code :} |
@@ -514,7 +514,7 @@ public final class NumericUtilities {
* 10 - renders number as a base-10 integer
* 16 (default) - renders number base-16 integer
*
- *
+ *
* | Number | Radix | DEFAULT Mode Alias | UNSIGNED Mode Value | SIGNED Mode Value |
|---|
* | | | | | |
* | 100 | 2 | UNSIGNED | 1100100b | 1100100b |
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/ReversedListIterator.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/ReversedListIterator.java
index d1b4d1c07f..3c53a41145 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/ReversedListIterator.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/ReversedListIterator.java
@@ -20,7 +20,7 @@ import java.util.ListIterator;
/**
* Wraps a {@link ListIterator} so that the operations are reversed.
*
- * @note you must obtain an iterator that is already at its end. E.g., if you wish to traverse a
+ * NOTE: you must obtain an iterator that is already at its end. E.g., if you wish to traverse a
* list in reverse, you would use
* {@code new ReversedListIterator<>(list.listIterator(list.size()))}.
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/TestSuiteUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/TestSuiteUtilities.java
index aa17669fc8..99bc0bce20 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/TestSuiteUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/TestSuiteUtilities.java
@@ -44,7 +44,7 @@ public class TestSuiteUtilities {
/**
* Build JUnit test suite for the specified package.
* TestSuite includes sub-TestSuites for each sub-package.
- * @param pkg java package
+ * @param pkgName the java package name
* @return test suite
*/
public static TestSuite getTestSuite(String pkgName) {
@@ -53,7 +53,7 @@ public class TestSuiteUtilities {
/**
* Build JUnit test suite for the specified package only.
- * @param pkg java package
+ * @param pkgName the java package name
* @return test suite
*/
public static TestSuite getPkgTestSuite(String pkgName) {
@@ -447,10 +447,10 @@ public class TestSuiteUtilities {
/**
* Create the Java source file a JUnit TestSuite which
* includes all TestCases within a package directory.
- * @param baseDir
- * @param className
- * @param pkgName
- * @param recurse
+ * @param baseDir the base package directory
+ * @param className the class name
+ * @param pkgName the java package name
+ * @throws IOException
*/
public static void createTestSuites(File baseDir, String className, String pkgName) throws IOException {
File dir = makeDir(baseDir, pkgName);
@@ -511,9 +511,9 @@ public class TestSuiteUtilities {
* Command-line utilities.
*
* Parameter usage:
- *
+ * {@literal
* createAllTests
- *
+ * }
* @param args
*/
public static void main(String[] args) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/UserSearchUtils.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/UserSearchUtils.java
index 1d88dbc445..e1765dcb82 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/UserSearchUtils.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/UserSearchUtils.java
@@ -73,7 +73,7 @@ public class UserSearchUtils {
* Create a regular expression from the given input. Note: the regular expression
* created by this method is not a pure regular expression. More specifically, many
* regular expression characters passed to this method will be escaped
- * (see {@link #escapeRegexCharacters(String, boolean, boolean)}.
+ * (see {@link #escapeAllRegexCharacters(String)}.
*
* Also, globbing characters
* will be changed from a regular expression meaning to a
@@ -96,7 +96,7 @@ public class UserSearchUtils {
* @param caseSensitive
* true if the regular expression is case sensitive
* @return Pattern the compiled regular expression
- * @throws PatternSyntaxExpression
+ * @throws java.util.regex.PatternSyntaxException
* if the input could be compiled
*/
public static Pattern createSearchPattern(String input, boolean caseSensitive) {
@@ -122,7 +122,7 @@ public class UserSearchUtils {
* @param text
* search string
* @return Pattern the compiled regular expression
- * @throws PatternSyntaxExpression
+ * @throws java.util.regex.PatternSyntaxException
* if the input could be compiled
*/
public static Pattern createLiteralSearchPattern(String text) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/bean/GGlassPane.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/bean/GGlassPane.java
index 44b4a78ee7..6c601b5b08 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/bean/GGlassPane.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/bean/GGlassPane.java
@@ -55,7 +55,7 @@ public class GGlassPane extends JComponent {
/**
* Default constructor.
*
- * NOTE: You must call {@link #setVisible( true )} on this component after adding it
+ * NOTE: You must call {@link #setVisible(boolean) setVisible(true)} on this component after adding it
* to the component. This is because the component will set the visibility to that of
* the previous glass pane, which is false by default.
*/
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/CallbackAccumulator.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/CallbackAccumulator.java
index 7e2603f9c0..e4c1af7780 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/CallbackAccumulator.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/CallbackAccumulator.java
@@ -24,8 +24,7 @@ import java.util.function.Consumer;
*
*
This class is different than normal accumulators in that the values are not
* stored internally. As such, calls to {@link #get()}, {@link #iterator()} and
- * {@link #size()} will reflect having no data. Further, to use this class, each client
- * must override {@link #itemAdded(Object)} in order to process the data as it arrives.
+ * {@link #size()} will reflect having no data.
*
* @param the type of the item being accumulated
*/
@@ -38,7 +37,7 @@ public class CallbackAccumulator implements Accumulator {
/**
* Constructor
*
- * @param consumer the consumer that will get called each time an item is addded
+ * @param consumer the consumer that will get called each time an item is added
*/
public CallbackAccumulator(Consumer consumer) {
this.consumer = Objects.requireNonNull(consumer, "Consumer callback cannot be null");
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/DoubleArrayArray.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/DoubleArrayArray.java
index 31f9e2c5d7..0fc906b916 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/DoubleArrayArray.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/DoubleArrayArray.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -90,7 +89,6 @@ public class DoubleArrayArray implements Array, Serializable {
* @return The double array at the given index. An empty array will
* be returned for any index not initialized to
* another value.
- * @exception throws IndexOutOfBoundsException if the index is negative
*/
public double[] get(int index) {
if (index <= starts.length) {
@@ -108,7 +106,6 @@ public class DoubleArrayArray implements Array, Serializable {
}
/** Removes the array at the given index
* @param index index of the array to be removed
- * @exception throws IndexOutOfBoundsException if the index is negative
*/
public void remove(int index) {
try {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/IntArrayList.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/IntArrayList.java
index bf2e085083..92f7de828c 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/IntArrayList.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/IntArrayList.java
@@ -63,7 +63,7 @@ public class IntArrayList implements Serializable, Saveable {
* @param value value to store
*
* @throws IndexOutOfBoundsException
- * if the index is negative OR index > size
+ * if the index is negative OR index > size
*/
public void add(int index, int value) {
if (index < 0 || index > size) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/LongArrayList.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/LongArrayList.java
index 3b13327374..2c350743e8 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/LongArrayList.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/LongArrayList.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -121,7 +120,7 @@ public class LongArrayList implements List {
return longs[index];
}
/**
- * @see ghidra.util.datastruct.LongArrayListIf#set(int, long)
+ * @see LongArraySubList#set(int, long)
*/
public Long set(int index, Long value) {
if (index < 0 || index >= size) {
@@ -133,7 +132,7 @@ public class LongArrayList implements List {
}
/**
- * @see ghidra.util.datastruct.LongArrayListIf#clear()
+ * @see LongArraySubList#clear()
*/
public void clear() {
size = 0;
@@ -141,14 +140,14 @@ public class LongArrayList implements List {
}
/**
- * @see ghidra.util.datastruct.LongArrayListIf#size()
+ * @see LongArraySubList#size()
*/
public int size() {
return size;
}
/**
- * @see ghidra.util.datastruct.LongArrayListIf#toArray()
+ * @see LongArraySubList#toArray()
*/
public Long [] toArray() {
Long[] values = new Long[size];
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackTree.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackTree.java
index a671007d7d..60786cf158 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackTree.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/datastruct/RedBlackTree.java
@@ -38,7 +38,6 @@ public class RedBlackTree, V> implements Iterable implements Iterable {
* Returns the element at the specified depth in this stack.
* 0 indicates the bottom of the stack.
* size()-1 indicates the top of the stack.
- * @param index the depth in the stack.
+ * @param depth the depth in the stack.
* @return the element at the specified depth in this stack
*/
public E get(int depth) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/MultipleCauses.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/MultipleCauses.java
index 862e965e07..0d2834a4f9 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/MultipleCauses.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/exception/MultipleCauses.java
@@ -36,7 +36,7 @@ public class MultipleCauses extends Throwable {
/**
* Constructs a new MultipleCauses wrapper with no causes
- * @note it is rude to leave this empty
+ * NOTE: it is rude to leave this empty
*/
public MultipleCauses() {
super("Multiple Causes");
@@ -64,7 +64,7 @@ public class MultipleCauses extends Throwable {
/**
* Returns the causes of the parent throwable (possibly an empty collection)
* @return the collection of causes of the parent throwable
- * @note it is rude to leave this empty. If the parent throwable has no cause, or the cause is
+ * NOTE: it is rude to leave this empty. If the parent throwable has no cause, or the cause is
* unknown, leave its cause null.
*/
public synchronized Collection getCauses() {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/filechooser/ExtensionFileFilter.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/filechooser/ExtensionFileFilter.java
index 170a693d60..a2e29ac282 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/filechooser/ExtensionFileFilter.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/filechooser/ExtensionFileFilter.java
@@ -32,7 +32,7 @@ import java.util.Hashtable;
*
* GhidraFileChooser chooser = new GhidraFileChooser();
* ExtensionFileFilter filter = new ExtensionFileFilter(
- * new String{"gif", "jpg"}, "JPEG & GIF Images")
+ * new String{"gif", "jpg"}, "JPEG and GIF Images")
* chooser.addFileFilter(filter);
*
*/
@@ -78,8 +78,8 @@ public class ExtensionFileFilter implements GhidraFileFilter {
*/
public ExtensionFileFilter(String[] filters, String description) {
this.filters = new Hashtable(filters.length);
- for (int i = 0; i < filters.length; i++) {
- addExtension(filters[i]);//add filters one by one
+ for (String filter : filters) {
+ addExtension(filter);//add filters one by one
}
setDescription(description);
}
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DepthFirstSearch.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DepthFirstSearch.java
index 2386346cce..a5ecfe9319 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DepthFirstSearch.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/DepthFirstSearch.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -389,7 +388,7 @@ public class DepthFirstSearch
* portion of the graph with the following
* property:
*
- * - If the graph is acyclic then v[i] -> v[j] => i < j .
+ * - {@literal If the graph is acyclic then v[i] -> v[j] => i < j .}
* - If the graph contains cycles, then the above is true except when
* (v[i],v[j]) is a back edge.
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/SimpleWeightedDigraph.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/SimpleWeightedDigraph.java
index 514d86e082..64c04512ca 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/SimpleWeightedDigraph.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/SimpleWeightedDigraph.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,7 +19,7 @@ package ghidra.util.graph;
*
* A simple graph is a graph with no parallel edges or loops. This class models
* a simple digraph -- edges are directed and a single edge may go from any vertex
- * to any other vertex. It is possible to have edges A-->B and B-->A however.
+ * to any other vertex. {@literal It is possible to have edges A-->B and B-->A however.}
* Attempting to add an edge from A to B when an edge from A to B already exists
* causes the edge weight to be increased by the defaultEdgeWeight or the weight
* specified.
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/ObjectAttribute.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/ObjectAttribute.java
index 6117a4af23..150fdb6c82 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/ObjectAttribute.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/ObjectAttribute.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -60,9 +59,8 @@ public class ObjectAttribute extends Attribute {
return false;
}
- /** Return the value associated to the specified KeyedObject.
- * @throws NoValueException if the value has not been set or
- * the KeyedObject does not belong to the owningSet.
+ /**
+ * Return the value associated to the specified KeyedObject.
*/
public Object getValue(KeyedObject o) //throws NoValueException
{
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/StringAttribute.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/StringAttribute.java
index bc2df77937..1478f8b404 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/StringAttribute.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/graph/attributes/StringAttribute.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -61,9 +60,8 @@ public class StringAttribute extends Attribute {
return false;
}
- /** Return the value associated to the specied KeyedObject.
- * @throws NoValueException if the value has not been set or
- * the KeyedObject does not belong to the owningSet.
+ /**
+ * Return the value associated to the specied KeyedObject.
*/
public String getValue(KeyedObject o) //throws NoValueException
{
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/html/HtmlLineSplitter.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/html/HtmlLineSplitter.java
index 18d549b96c..0c7a98bd5c 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/html/HtmlLineSplitter.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/html/HtmlLineSplitter.java
@@ -47,7 +47,7 @@ public class HtmlLineSplitter {
* @param maxLineLength the max desired length of each output line; 0 or less signals not
* to wrap the line based upon length
* @return the new lines
- * @see #wrap(String, int)
+ * @see #wrap(String, int, WhitespaceHandler)
* @see #split(String, int, boolean)
*/
public static List split(String text, int maxLineLength) {
@@ -66,7 +66,7 @@ public class HtmlLineSplitter {
* @param retainSpacing true signals to keep whitespace on line breaks; false discards
* leading whitespace
* @return the new lines
- * @see #wrap(String, int)
+ * @see #wrap(String, int, WhitespaceHandler)
*/
public static List split(String text, int maxLineLength, boolean retainSpacing) {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingRunnable.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingRunnable.java
index 9fa400a449..f92b94870e 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingRunnable.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/task/SwingRunnable.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,8 +21,8 @@ package ghidra.util.task;
* Pass a SwingRunnable to the RunManager if follow on work needs to be done
* after the run() method completes.
*
-* @see RunManager#run(MonitoredRunnable, String)
-* @see ghidra.util.task.RunManager#run(MonitoredRunnable, String, int)
+* @see RunManager#runNext(MonitoredRunnable, String)
+* @see RunManager#runNext(MonitoredRunnable, String, int)
*
*/
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 ed49101ab1..4603df1ecf 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
@@ -42,9 +42,9 @@ import utilities.util.reflection.ReflectionUtilities;
* Non-blocking update now - this is a conceptual use-case, where the client wishes to perform an
* immediate update, but not during the current Swing event. To achieve
* this, you could call something like:
- *
+ * {@literal
* SwingUtilities.invokeLater(() -> updateManager.updateNow());
- *
+ * }
*
*
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/worker/AbstractWorker.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/worker/AbstractWorker.java
index fcb099f5e3..4c61e86d1b 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/worker/AbstractWorker.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/worker/AbstractWorker.java
@@ -215,8 +215,8 @@ public abstract class AbstractWorker {
* Warning: Calling this method may leave the program in a bad
* state. Thus, it is recommended that you only do so when you known that any job that
* could possibly be scheduled does not manipulate sensitive parts of the program; for
- * example, opening file handles that should be closed before finishing.
- *
+ * example, opening file handles that should be closed before finishing.
+ *
* If you are unsure
* about whether your jobs handle interrupt correctly, then don't use this method.
*
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlAttributes.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlAttributes.java
index 0cbb3608e2..f6009d197a 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlAttributes.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlAttributes.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,7 +28,7 @@ import java.math.BigInteger;
* attrs.add("BAR", "foo");
* attrs.add("PI", 3.14159);
*
- * The output would be: FIVE="0x20" BAR="foo" PI="3.14159".
+ * The output would be: FIVE="0x20" BAR="foo" PI="3.14159".
*
*/
public class XmlAttributes {
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java
index 2f4727bc1b..485a919e87 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/util/xml/XmlUtilities.java
@@ -652,7 +652,7 @@ public class XmlUtilities {
*
* @param ele the parent element
* @param childName the name of the children elements to return
- * @return List of elements
+ * @return {@literal List} of elements
*/
public static List getChildren(Element ele, String childName) {
return CollectionUtils.asList(ele.getChildren(childName), Element.class);
diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/xml/XmlPullParserFactory.java b/Ghidra/Framework/Generic/src/main/java/ghidra/xml/XmlPullParserFactory.java
index 9802b98f9e..4c0421f880 100644
--- a/Ghidra/Framework/Generic/src/main/java/ghidra/xml/XmlPullParserFactory.java
+++ b/Ghidra/Framework/Generic/src/main/java/ghidra/xml/XmlPullParserFactory.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -34,7 +33,7 @@ public class XmlPullParserFactory {
*
* @param input
* the input XML stream
- * @param name
+ * @param inputName
* the name of the stream
* @param errHandler
* the XML error handler
@@ -100,8 +99,6 @@ public class XmlPullParserFactory {
* true if the parse should validate against the DTD
* @throws SAXException
* if an XML parse error occurs
- * @throws IOException
- * if an i/o error occurs
*/
public static XmlPullParser create(String input, String inputName, ErrorHandler errHandler,
boolean validate) throws SAXException {
diff --git a/Ghidra/Framework/Generic/src/main/java/log/Log4jDevelopmentPatternConverter.java b/Ghidra/Framework/Generic/src/main/java/log/Log4jDevelopmentPatternConverter.java
index e000da5b93..4ce2381679 100644
--- a/Ghidra/Framework/Generic/src/main/java/log/Log4jDevelopmentPatternConverter.java
+++ b/Ghidra/Framework/Generic/src/main/java/log/Log4jDevelopmentPatternConverter.java
@@ -31,7 +31,7 @@ import utilities.util.reflection.ReflectionUtilities;
* of the current log message. This is to be used in log4j configurations as part
* of a pattern layout. eg:
*
- *
+ * {@literal }
*
* See generic.log4jdev.xml for a working example.
*/
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GEdge.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GEdge.java
index f25510feba..3bc790d49b 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GEdge.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GEdge.java
@@ -25,7 +25,7 @@ public interface GEdge {
/**
* Get the start, or tail, of the edge
*
- * In the edge x -> y, x is the start
+ *
In the edge x -> y, x is the start
*
* @return the start
*/
@@ -34,7 +34,7 @@ public interface GEdge {
/**
* Get the end, or head, of the edge
*
- * In the edge x -> y, y is the end
+ *
In the edge x -> y, y is the end
*
* @return the end
*/
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GImplicitDirectedGraph.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GImplicitDirectedGraph.java
index 29cbec3abd..0cae240425 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GImplicitDirectedGraph.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GImplicitDirectedGraph.java
@@ -35,8 +35,8 @@ public interface GImplicitDirectedGraph> {
*
* (Optional operation)
*
- * @note This method ought to return cached results if available
- * @note As part of computing in-edges, this method will also provide predecessors
+ * NOTE: This method ought to return cached results if available
+ * NOTE: As part of computing in-edges, this method will also provide predecessors
*
* @param v the destination vertex
* @return the in-edges to the given vertex
@@ -46,8 +46,8 @@ public interface GImplicitDirectedGraph> {
/**
* Compute the incident edges that start at the given vertex
*
- * @note This method ought to return cached results if available
- * @note As part of computing out-edges, this method will also provide successors
+ * NOTE: This method ought to return cached results if available
+ * NOTE: As part of computing out-edges, this method will also provide successors
*
* @param v the source vertex
* @return the out-edges from the given vertex
@@ -59,7 +59,7 @@ public interface GImplicitDirectedGraph> {
*
* The default implementation computes this from the in-edges
*
- * @note If a non-default implementation is provided, it ought to return cached results if
+ * NOTE: If a non-default implementation is provided, it ought to return cached results if
* available
*
* @param v the destination vertex
@@ -78,7 +78,7 @@ public interface GImplicitDirectedGraph> {
*
* The default implementation compute this from the out-edges
*
- * @note If a non-default implementation is provided, it ought to return cached results if
+ * NOTE: If a non-default implementation is provided, it ought to return cached results if
* available
*
* @param v the source vertex
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GWeightedEdge.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GWeightedEdge.java
index e89768ac29..48ddf3c280 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GWeightedEdge.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/GWeightedEdge.java
@@ -18,7 +18,7 @@ package ghidra.graph;
/**
* An edge having a natural weight
*
- * param the type of vertices
+ * @param the type of vertices
*/
public interface GWeightedEdge extends GEdge {
/**
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/DijkstraShortestPathsAlgorithm.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/DijkstraShortestPathsAlgorithm.java
index d1103f628d..c73f25e378 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/DijkstraShortestPathsAlgorithm.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/algo/DijkstraShortestPathsAlgorithm.java
@@ -60,7 +60,6 @@ public class DijkstraShortestPathsAlgorithm> {
* likely encounter a {@link ClassCastException}.
*
* @param graph the graph
- * @param maxDistance the maximum distance, or null for no maximum
*/
public DijkstraShortestPathsAlgorithm(GImplicitDirectedGraph graph) {
this.graph = graph;
@@ -87,7 +86,6 @@ public class DijkstraShortestPathsAlgorithm> {
* Use Dijstra's algorithm on the given graph with a custom edge weight metric
*
* @param graph the graph
- * @param maxDistance the maximum distance, or null for no maximum
* @param metric the function to compute the weight of an edge
*/
public DijkstraShortestPathsAlgorithm(GImplicitDirectedGraph graph,
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/event/VisualGraphChangeListener.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/event/VisualGraphChangeListener.java
index 842a01ee07..00d4e56520 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/event/VisualGraphChangeListener.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/event/VisualGraphChangeListener.java
@@ -37,14 +37,14 @@ public interface VisualGraphChangeListener {
/**
* Called when the given edges have been added from the graph
*
- * @param vertices the added edges
+ * @param edges the added edges
*/
public void edgesAdded(Iterable edges);
/**
* Called when the given edges have been removed from the graph
*
- * @param vertices the removed edges
+ * @param edges the removed edges
*/
public void edgesRemoved(Iterable edges);
}
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VisualGraphFeaturette.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VisualGraphFeaturette.java
index 3d28f32f8f..8809b863f6 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VisualGraphFeaturette.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/featurette/VisualGraphFeaturette.java
@@ -50,7 +50,7 @@ public interface VisualGraphFeaturetteImplementation Notes
+ * Implementation Notes
*
- * Jung Vertex/Edge Rendering
+ * Jung Vertex/Edge Rendering
* Jung creates shapes for vertices (see {@link VertexShapeFactory}) that are centered. They
* do this by getting the width/height of the shape and then creating an x/y value that is
* half of the width and height, respectively. This has the effect of the vertex appearing
@@ -55,7 +55,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
* Jung's.
*
If we ever decide instead to not center our shapes, then this renderer would have to be
* updated to itself center the edge shape created herein, like this:
- *
+ * {@literal
* Rectangle b1 = s1.getBounds();
* Rectangle b2 = s2.getBounds();
*
@@ -70,7 +70,7 @@ import ghidra.graph.viewer.vertex.VisualGraphVertexShapeTransformer;
* float tx2 = x2 + w2;
* float ty2 = y2 + h2;
* Shape edgeShape = getEdgeShape(rc, graph, e, tx1, ty1, tx2, ty2, isLoop, xs1);
- *
+ * }
* Also, there are other spots in the system where we account for this center that would
* have to be changed, such as the {@link AbstractVisualGraphLayout}, which needs the centering
* offsets to handle vertex clipping.
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/GridLocationMap.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/GridLocationMap.java
index 91e7e1961e..65b0f74954 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/GridLocationMap.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/GridLocationMap.java
@@ -29,7 +29,7 @@ import org.apache.commons.collections4.map.LazyMap;
* class are row, column grid values, starting at 0,0.
*
*
Note: the Point2D values for the edge articulations use x,y values that are row and
- * column index values, the same values as calling {@link #row(V)} and {@link #col(V)}.
+ * column index values, the same values as calling {@link #row(Object) row(V)} and {@link #col(Object) col(V)}.
*
*
After building the grid using this class, clients can call {@link #rows()} to get
* high-order object that represent rows.
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/Row.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/Row.java
index 2c27a46509..527f9ffefa 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/Row.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/Row.java
@@ -29,7 +29,7 @@ import ghidra.graph.viewer.GraphViewerUtils;
* of a grid.
*
*
This class maintains a collection of vertices on this row, organized by column index. You
- * can get the column of a vertex from {@link #getColumn(V)}.
+ * can get the column of a vertex from {@link #getColumn(Object) getColumn(V)}.
*/
public class Row {
@@ -131,7 +131,7 @@ public class Row {
* Returns all vertices in this row, sorted by column index (min to max).
*
* Note: the index of a vertex in the list does not match the column index. To get the
- * column index for a vertex, call {@link #getColumn(V)}.
+ * column index for a vertex, call {@link #getColumn(Object) getColumn(V)}.
*
* @return all vertices in this row
*/
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/VisualGraphLayout.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/VisualGraphLayout.java
index 070f2dfb88..327061b03f 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/VisualGraphLayout.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/layout/VisualGraphLayout.java
@@ -34,7 +34,6 @@ import ghidra.util.task.TaskMonitor;
*
* @param the vertex type
* @param the edge type
- * @param the graph type
*/
//@formatter:off
public interface VisualGraphLayout{@link VisualEdge#articulations What are articulations?}
+ * What are articulations?
*
* @return true if this layout uses articulated edges.
- * @see ArticulatedEdge
*/
public boolean usesEdgeArticulations();
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VertexFocusListener.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VertexFocusListener.java
index 8fa9c79526..11f5fc0f73 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VertexFocusListener.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VertexFocusListener.java
@@ -19,7 +19,6 @@ package ghidra.graph.viewer.vertex;
* A listener called when a vertex is focused.
*
* @param the vertex type
- * @param the edge type
*/
public interface VertexFocusListener {
diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VisualGraphVertexShapeTransformer.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VisualGraphVertexShapeTransformer.java
index 78e7cfdb37..60cd288665 100644
--- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VisualGraphVertexShapeTransformer.java
+++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/vertex/VisualGraphVertexShapeTransformer.java
@@ -53,7 +53,7 @@ public class VisualGraphVertexShapeTransformer
* Returns the full (the actual) shape of a vertex. This can be used to determine if a
* mouse point intersects a vertex or to get the real bounding-box of a vertex.
*
- * @param the vertex
+ * @param v the vertex
* @return the shape
*/
public Shape transformToFullShape(V v) {
diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemDefinition.java b/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemDefinition.java
index 16921a8f89..c6e247c023 100644
--- a/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemDefinition.java
+++ b/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemDefinition.java
@@ -20,7 +20,7 @@ import java.nio.file.Path;
import help.validator.LinkDatabase;
/**
- * A representation of the tag, which is a way to define a TOC item entry in
+ * A representation of the {@literal } tag, which is a way to define a TOC item entry in
* a TOC_Source.xml file.
*/
public class TOCItemDefinition extends TOCItem {
diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemReference.java b/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemReference.java
index 7d6ede88bf..e3f1cd1fa8 100644
--- a/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemReference.java
+++ b/Ghidra/Framework/Help/src/main/java/help/validator/model/TOCItemReference.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,7 +20,7 @@ import help.validator.LinkDatabase;
import java.nio.file.Path;
/**
- * A representation of the tag, which is a way to reference a TOC item entry in
+ * A representation of the {@literal } tag, which is a way to reference a TOC item entry in
* a TOC_Source.xml file other than the one in which the reference lives.
*/
public class TOCItemReference extends TOCItem implements Comparable {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/merge/MergeProgressModifier.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/merge/MergeProgressModifier.java
index 330ed701a7..8e7c17befe 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/app/merge/MergeProgressModifier.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/app/merge/MergeProgressModifier.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,12 +19,10 @@ public interface MergeProgressModifier {
/**
* Updates the current phase progress area in the default merge panel.
- * @param currentProgressPercentage the progress percentage completed for the current phase.
- * This should be a value from 0 to 100.
* @param progressMessage a message indicating what is currently occurring in this phase.
* Null indicates to use the default message.
*/
- public void updateProgress(final String description);
+ public void updateProgress(final String progressMessage);
/**
* Updates the current phase progress area in the default merge panel.
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/plugin/core/help/AboutDomainObjectUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/plugin/core/help/AboutDomainObjectUtils.java
index 862966b8c4..03142d5c20 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/app/plugin/core/help/AboutDomainObjectUtils.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/app/plugin/core/help/AboutDomainObjectUtils.java
@@ -44,13 +44,12 @@ public class AboutDomainObjectUtils {
* Displays an informational dialog about the specified domain object
*
* @param tool plugin tool
- * @param domainObject domain object to display information about
+ * @param domainFile domain file to display information about
+ * @param metadata the metadata for the domainFile
* @param title title to use for the dialog
* @param additionalInfo additional custom user information to append to
* the bottom of the dialog
- * @param shouldParent true means that about dialog will be parented
- * to parent, false means that only
- * the location will be set relative to parent
+ * @param helpLocation the help location
*/
public static void displayInformation(PluginTool tool, DomainFile domainFile,
Map metadata, String title, String additionalInfo,
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/DomainObjectMergeManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/DomainObjectMergeManager.java
index 10183ab41a..ca97a0adc6 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/DomainObjectMergeManager.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/DomainObjectMergeManager.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,7 +39,8 @@ public interface DomainObjectMergeManager extends MergeProgressModifier {
* @param infoType the string indicating the type of resolve information
* @param infoObject the object for the named string. This information is
* determined by the merge manager that creates it.
- * @see getResolveInformation(String)
+ * @see ghidra.app.merge.MergeManager#getResolveInformation(String)
+ * MergeManager.getResolveInformation(String)
*/
public void setResolveInformation(String infoType, Object infoObject);
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/GhidraFolderData.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/GhidraFolderData.java
index 5557deec20..609b16dc1a 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/GhidraFolderData.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/GhidraFolderData.java
@@ -760,9 +760,8 @@ class GhidraFolderData {
/**
* Check for existence of file. If folder visited, rely on fileDataCache
- * @param fileName
- * @param doRealCheck if true do not rely on fileList
- * @return
+ * @param fileName the name of the file to check for
+ * @return true if this folder contains the fileName
* @throws IOException
*/
public boolean containsFile(String fileName) throws IOException {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ProjectFileManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ProjectFileManager.java
index d54fd41062..593dbd79a0 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ProjectFileManager.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ProjectFileManager.java
@@ -89,7 +89,7 @@ public class ProjectFileManager implements ProjectData {
* Constructor for existing projects.
* @param localStorageLocator the location of the project
* @param isInWritableProject true if project content is writable, false if project is read-only
- * @param inProject true if this is the active project
+ * @param resetOwner true to reset the project owner
* @throws IOException if an i/o error occurs
* @throws NotOwnerException if inProject is true and user is not owner
* @throws FileNotFoundException if project directory not found
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ToolState.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ToolState.java
index bc3536f3ba..aaed6906e5 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ToolState.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/data/ToolState.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,7 +30,7 @@ public class ToolState {
/**
* Construct a new tool state.
* @param tool tool's state to save
- * @param element element containing tool state
+ * @param domainObject the object containing the tool state
*/
public ToolState(PluginTool tool, DomainObject domainObject) {
this.tool = tool;
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/EditPluginPathDialog.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/EditPluginPathDialog.java
index faa5686da7..f511419714 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/EditPluginPathDialog.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/EditPluginPathDialog.java
@@ -109,7 +109,7 @@ class EditPluginPathDialog extends DialogComponentProvider {
/**
* Define the Main panel for the dialog here.
- * @return JPanel the completed Main Panel<\CODE>
+ * @return JPanel the completed Main Panel
*/
protected JPanel buildMainPanel() {
// give base class the panel it needs to complete its construction
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java
index 565f65ec7f..d26ecf2a8c 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/ProjectAccessPanel.java
@@ -40,9 +40,11 @@ import util.CollectionUtils;
* Panel that shows the users for a given repository and the users associated with the current
* shared project. There are 3 main sub-panels:
*
+ *
* - Known Users Panel: Displays all users in the repository
* - Button Panel: Provides buttons for adding/removing users from the project
* - User Access Panel: Displays all users on the project, and their access permissions
+ *
*
* If the current user is an admin, he may change user permissions and add/remove them
* from the project. If not, only the User Access Panel will be visible and it will
@@ -70,7 +72,7 @@ public class ProjectAccessPanel extends AbstractWizardJPanel {
/**
* Construct a new panel from a {@link RepositoryAdapter} instance.
*
- * @param knownUser names of the users that are known to the remote server
+ * @param knownUsers names of the users that are known to the remote server
* @param repository the repository adapter instance
* @param tool the current tool
* @throws IOException if there's an error processing the repository user list
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/CheckInTask.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/CheckInTask.java
index 860a9c39ee..1f283a3a60 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/CheckInTask.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/CheckInTask.java
@@ -45,7 +45,6 @@ public class CheckInTask extends VersionControlTask implements CheckinHandler {
* Construct a new CheckInTask.
* @param tool tool that has the files to be checked in
* @param list list of domain files to be checked in
- * @param taskListener listener that is notified when this task completes
* @param parent parent of error dialog if an error occurs
*/
public CheckInTask(PluginTool tool, List list, Component parent) {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/event/FVEvent.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/event/FVEvent.java
index c3a14add0c..744e6aa4a5 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/event/FVEvent.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/event/FVEvent.java
@@ -17,7 +17,7 @@ package ghidra.framework.main.logviewer.event;
/**
* Custom events to be used in conjunction with the {@link FVEventListener} module. Users should
- * construct an event, then fire it using {@link FVEventListener#sendEvent(FVEvent)}.
+ * construct an event, then fire it using {@link FVEventListener#send(FVEvent)}.
*
* Two items are passed along with each event:
* - The {@link #eventType} attribute specifies the event that is being fired.
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FVSlider.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FVSlider.java
index c4d15a5c0a..0b3f22c95f 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FVSlider.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FVSlider.java
@@ -29,21 +29,22 @@ import ghidra.framework.main.logviewer.model.*;
import ghidra.util.Msg;
/**
- * Custom slider that acts as the scroll bar for the {@link FVTable}. This slider listens for
+ * Custom slider that acts as the scroll bar for the FVTable. This slider listens for
* changes to the viewport and updates its position accordingly.
*
- * Q. Why not just use the standard {@link JScrollbar} that comes with the {@link JScrollPane}?
+ * Q. Why not just use the standard {@link javax.swing.JScrollBar JScrollBar} that comes with the {@link JScrollPane}?
*
- * A. It's because we are viewing only a portion of the total file at any given time; if we used the
- * standard scroll mechanism, it would size itself and its viewport according to that subset
- * of the total file, while we want it to reflect the file in its entirety.
+ * A. It's because we are viewing only a portion of the total file at any given time.
+ * If we used the standard scroll mechanism, it would size itself and its viewport
+ * according to that subset of the total file, while we want it to reflect the file
+ * in its entirety.
*
- * Q. Why extend a JSlider for this custom scroll bar instead of a JScrollBar?
- *
- * A. The JSlider is much easier to customize, specifically when trying to adjust the size of the
- * slider thumb. Functionally they are both acceptable for our purposes, but the ease of using
- * the slider wins out.
+ * Q. Why extend a {@link JSlider} for this custom scroll bar instead of a {@link JScrollBar}?
*
+ * A. The {@link JSlider} is much easier to customize, specifically when trying to adjust
+ * the size of the slider thumb. Functionally they are both acceptable for our
+ * purposes, but the ease of using the slider wins out.
+ *
*/
public class FVSlider extends JSlider
implements ChangeListener, MouseMotionListener, MouseListener {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FileViewer.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FileViewer.java
index f070a96c88..8726422449 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FileViewer.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/FileViewer.java
@@ -39,7 +39,7 @@ import utilities.util.FileUtilities;
* Notes:
* 1. The viewer consists of a simple JTable and a custom JSlider. The table displays lines of
* text described by {@link Chunk} objects. The number of chunks visible at any given time
- * is restricted by the {@link Chunk#MAX_VISIBLE_CHUNKS} property.
+ * is restricted by the {@link ChunkModel#MAX_VISIBLE_CHUNKS} property.
*
* 2. Because only part of the file is loaded into the viewable table at any given time, the
* built-in scrollbar associated with the scrollpane cannot be used. We want the scroll bar
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ReloadDialog.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ReloadDialog.java
index ff2d6fc31a..d9031bbbea 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ReloadDialog.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ReloadDialog.java
@@ -30,8 +30,9 @@ import ghidra.framework.main.logviewer.event.FVEventListener;
* Simple warning dialog for letting the user know when the input file has been updated. This
* includes an option allowing the user to opt-out of seeing subsequent pop-ups.
*
- * Note: The Ghidra {@link OptionPanel} is not sufficient for this as it doesn't allow for
- * custom objects to be displayed (the opt-out checkbox).
+ * Note: The Ghidra {@link docking.options.editor.OptionsPanel OptionsPanel}
+ * is not sufficient for this as it doesn't allow for custom objects to be
+ * displayed (the opt-out checkbox).
*
*/
public class ReloadDialog extends JDialog {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java
index a49e83233f..9105e2f39a 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/logviewer/ui/ViewportUtility.java
@@ -31,7 +31,7 @@ import ghidra.util.Msg;
/**
* Utility class for managing the viewport in the {@link FVTable}. This viewport must be
* adjusted manually whenever {@link Chunk} objects are added to or removed from to the view,
- * or whenever the {@link FVScrollBar} is moved.
+ * or whenever the {@link FVSlider} is moved.
*
*/
public class ViewportUtility implements Observer {
@@ -175,7 +175,6 @@ public class ViewportUtility implements Observer {
*
* @param rows
* @param selection
- * @return
*/
public void moveViewportUp(int rows, boolean selection) {
@@ -254,7 +253,6 @@ public class ViewportUtility implements Observer {
*
* @param rows
* @param selection
- * @return
*/
public void moveViewportDown(int rows, boolean selection) {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/VersionControlCheckInAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/VersionControlCheckInAction.java
index d1a03a60bd..143a3d7edf 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/VersionControlCheckInAction.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/VersionControlCheckInAction.java
@@ -105,7 +105,6 @@ public class VersionControlCheckInAction extends VersionControlAction {
* Check in the list of domain files.
* Domain files that cannot be closed are skipped in the list.
* @param fileList list of DomainFile objects
- * @param listener the task listener that is notified when task completes
*/
public void checkIn(List fileList) {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFile.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFile.java
index 65d9822b3b..a825f22190 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFile.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFile.java
@@ -308,7 +308,6 @@ public interface DomainFile extends Comparable {
/**
* Return the latest version
- * @throws IOException thrown if an IO or access error occurs.
*/
public int getLatestVersion();
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFolder.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFolder.java
index 566b3ccc09..4b2274ca18 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFolder.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainFolder.java
@@ -181,7 +181,7 @@ public interface DomainFolder extends Comparable {
/**
* Copy this folder into the newParent folder.
* @param newParent new parent folder
- * @param new folder
+ * @param monitor the task monitor
* @throws DuplicateFileException if a folder or file by
* this name already exists in the newParent folder
* @throws IOException thrown if an IO or access error occurs.
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectData.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectData.java
index a19305485d..affeb67057 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectData.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectData.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -88,12 +87,11 @@ public interface ProjectData {
public DomainFile getFileByID(String fileID);
/**
- * Get a GhidraURL for a shared domain file which is available
+ * Get a URL for a shared domain file which is available
* within a remote repository.
* @param path the absolute path of domain file relative to the root folder.
* @return URL object for accessing shared file from outside of a project, or
* null if file does not exist or is not shared.
- * @see ghidra.framework.data.URLGhidraRepository
*/
public URL getSharedFileURL(String path);
@@ -177,7 +175,7 @@ public interface ProjectData {
public void close();
/**
- * @returns the maximum name length permitted for folders or items.
+ * @return the maximum name length permitted for folders or items.
*/
public int getMaxNameLength();
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java
index 1c77c7e410..83fe922ec4 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ProjectDataUtils.java
@@ -95,7 +95,7 @@ public class ProjectDataUtils {
}
/**
- * Recursively traverse the {@link DomainFolders}s under a specific {@link DomainFolder}.
+ * Recursively traverse the {@link DomainFolder}s under a specific {@link DomainFolder}.
*
* @param startFolder
*/
@@ -140,7 +140,7 @@ public class ProjectDataUtils {
}
/**
- * Returns a {@link Iterable} sequence of all the {@link DomainFolders}s that exist under
+ * Returns a {@link Iterable} sequence of all the {@link DomainFolder}s that exist under
* the specified {@link DomainFolder folder}.
* @param folder
* @return
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolListener.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolListener.java
index 8b197a4bc1..fdc017e78d 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolListener.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolListener.java
@@ -18,16 +18,16 @@ package ghidra.framework.model;
import ghidra.framework.plugintool.PluginEvent;
/**
- * Interface to be implemented by objects that want to receive ToolEvents.
+ * Interface to be implemented by objects that want to receive PluginEvents.
* Tools must be registered for a particular event to actually receive it.
*
- * @see ToolEvent
+ * @see PluginEvent
*/
public interface ToolListener {
/**
- * This method is invoked when the registered ToolEvent event occurs.
+ * This method is invoked when the registered PluginEvent event occurs.
*
* @param toolEvent The cross-tool PluginEvent.
*/
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolServices.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolServices.java
index 76f82be5a8..bed0424e18 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolServices.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/ToolServices.java
@@ -107,7 +107,6 @@ public interface ToolServices {
* Launch the default tool; if domainFile is not null, this file will
* be opened in the tool.
* @param domainFile the file to open; may be null
- * @see #setDefaultTool(ToolTemplate)
*/
public Tool launchDefaultTool(DomainFile domainFile);
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ComponentProviderAdapter.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ComponentProviderAdapter.java
index 0bb35b5e55..98d7871407 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ComponentProviderAdapter.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/ComponentProviderAdapter.java
@@ -29,8 +29,9 @@ public abstract class ComponentProviderAdapter extends ComponentProvider {
protected PluginTool tool;
/**
- * Creates a new component provider with a default location of {@link PluginTool#WINDOW}.
- * @param windowMgr The window manager that will manage and show this provider.
+ * Creates a new component provider with a default location of
+ * {@link docking.WindowPosition#WINDOW WindowPosition.WINDOW}.
+ * @param tool the plugin tool.
* @param name The providers name. This is used to group similar providers into a tab within
* the same window.
* @param owner The owner of this provider, usually a plugin name.
@@ -40,8 +41,9 @@ public abstract class ComponentProviderAdapter extends ComponentProvider {
}
/**
- * Creates a new component provider with a default location of {@link PluginTool#WINDOW}.
- * @param windowMgr The window manager that will manage and show this provider.
+ * Creates a new component provider with a default location of
+ * {@link docking.WindowPosition#WINDOW WindowPosition.WINDOW}.
+ * @param tool the plugin tool.
* @param name The providers name. This is used to group similar providers into a tab within
* the same window.
* @param owner The owner of this provider, usually a plugin name.
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
index 447ba24d20..54ff0fd681 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/Plugin.java
@@ -67,7 +67,8 @@ import ghidra.util.classfinder.ExtensionPoint;
* {@link Plugin#registerServiceProvided(Class, Object) registerServiceProvided()}.
* (required)
* Create Actions (optional)
- * Register {@link Options} with the {@link PluginTool#getOptions(String)}. (optional)
+ * Register {@link ghidra.framework.options.Options Options} with the
+ * {@link PluginTool#getOptions(String)}. (optional)
*
* Other Plugins are constructed, dependencies evaluated, etc.
* If your dependencies are not available (ie. not installed, threw an exception during their
@@ -104,8 +105,7 @@ import ghidra.util.classfinder.ExtensionPoint;
* All Plugins must be tagged with a {@link PluginInfo @PluginInfo(...)} annotation.
*
* The annotation gives you the ability to declare a dependency on another Plugin
- * via the {@link PluginInfo#servicesRequired() servicesRequired} /
- * {@link PluginInfo#servicesUsed() servicesUsed}
+ * via the {@link PluginInfo#servicesRequired() servicesRequired}
*
* Ghidra will ensure that your Plugin will not be {@link #init() initialized} until all
* of its required services are loaded successfully and are available for use when your Plugin
@@ -491,7 +491,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser
* Plugins should override this method if they update their state
* when a particular service is added.
*
- * @param interfaceClass The interface of the added service
+ * @param interfaceClass The interface of the added service
* @param service service that is being added
*/
@Override
@@ -505,7 +505,7 @@ public abstract class Plugin implements ExtensionPoint, PluginEventListener, Ser
* Plugins should override this method if they update their state
* when a particular service is removed.
*
- * @param interfaceClass The interface of the added service
+ * @param interfaceClass The interface of the added service
* @param service that is being removed.
*/
@Override
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java
index 8a94225358..b16899b05c 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/PluginInfo.java
@@ -24,7 +24,7 @@ import ghidra.framework.plugintool.util.PluginStatus;
*
* Example:
*
- * @PluginInfo(
+ * @PluginInfo(
* status = PluginStatus.RELEASED,
* packageName = CorePluginPackage.NAME,
* category = PluginCategoryNames.COMMON,
@@ -32,7 +32,6 @@ import ghidra.framework.plugintool.util.PluginStatus;
* description = "Longer description of plugin.",
* servicesProvided = { ServiceInterfaceThisPluginProvides.class }
* servicesRequired = { RequiredServiceInterface1.class, RequiredServiceInterface2.class },
- * servicesUsed = { OptionalServiceInterface1.class, OptionalServiceInterface2.class },
* eventsConsumed = { SomePluginEvent.class },
* eventsProduced = { AnotherPluginEvent.class },
* isSlowInstallation = false
@@ -68,6 +67,7 @@ public @interface PluginInfo {
* PluginCategoryNames.COMMON
* PluginCategoryNames.SUPPORT
* PluginCategoryNames.etc
+ *
* @return String category
*/
String category();
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/StandAloneApplication.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/StandAloneApplication.java
index 096cc3b9a0..76e165929a 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/StandAloneApplication.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/StandAloneApplication.java
@@ -58,7 +58,7 @@ public abstract class StandAloneApplication implements GenericStandAloneApplicat
* The given properties file is expected to have the
* {@link ApplicationProperties#APPLICATION_NAME_PROPERTY} and
* {@link ApplicationProperties#APPLICATION_VERSION_PROPERTY} properties
- * set.
+ * set.
*
* @param propertiesFilename the name of the properties file.
*/
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/ExtensionUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/ExtensionUtils.java
index 7f1d367f94..f67c3c8744 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/ExtensionUtils.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/ExtensionUtils.java
@@ -945,7 +945,7 @@ public class ExtensionUtils {
* Attempts to delete any extension directories that do not contain a Module.manifest
* file. This indicates that the extension was slated to be uninstalled by the user.
*
- * @see ExtensionTableModel#uninstallExtension
+ * @see #uninstall
*/
public static void cleanupUninstalledExtensions() {
if (SystemUtilities.isInDevelopmentMode()) {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/mgr/OptionsManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/mgr/OptionsManager.java
index 33048e6625..909043b0b2 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/mgr/OptionsManager.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/mgr/OptionsManager.java
@@ -132,7 +132,7 @@ public class OptionsManager implements OptionsService, OptionsChangeListener {
/**
* Deregister the owner from the options; if options are empty, then
* remove the options from the map.
- * @param owner owner name
+ * @param ownerPlugin the owner plugin
*/
//TODO anyone using this Or should they be?
public void deregisterOwner(Plugin ownerPlugin) {
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 f8f6bb5e41..02de3a8681 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
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -50,8 +49,8 @@ public interface OptionsService {
* expected to be the name of a node in the options tree, residing under the root node. You
* may also provide the name of such a node, followed by the options delimiter, followed by
* the name of a child node under that node. For example, suppose in the options tree exists
- * a node Root->Foo
You may pass the value "Foo" to get that node. Or, suppose
- * in the options tree exists a node Root->Foo->childNode1
In this case, you may
+ * a node {@literal Root->Foo} You may pass the value "Foo" to get that node. Or, suppose
+ * in the options tree exists a node {@literal Root->Foo->childNode1} In this case, you may
* pass the value "Foo.childNode1", where the '.' character is the delimiter of the
* {@link ToolOptions} class (this is the value at the time of writing this documentation).
*
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java
index 8000c0e74a..df384a2694 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/util/PluginDescription.java
@@ -170,7 +170,7 @@ public class PluginDescription implements Comparable {
/**
* Return the description of the plugin.
- * @return "" if no description was specified
+ * @return {@code ""} if no description was specified
*/
public String getDescription() {
return description;
@@ -284,9 +284,9 @@ public class PluginDescription implements Comparable {
/**
* Constructs a new PluginDescription for the given plugin class.
*
- * Deprecated, use {@link PluginInfo @PluginInfo} instead.
+ * @deprecated, use {@link PluginInfo @PluginInfo} instead.
*
- * @param pluginClass the class of the plugin
+ * @param pluginClassParam the class of the plugin
* @param status the status, UNSTABLE, STABLE, RELEASED, DEBUG, or EXAMPLE
* @param pluginPackage the package to which the plugin belongs (see {@link PluginPackage}
* subclasses for examples)
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/DefaultProject.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/DefaultProject.java
index 45799a8386..6e53c4e81f 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/DefaultProject.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/DefaultProject.java
@@ -323,7 +323,7 @@ public class DefaultProject implements Project {
/**
* Get the local tool chest for the user logged in.
*
- * @returns the tool chest
+ * @return the tool chest
*/
@Override
public ToolChest getLocalToolChest() {
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraProtocolHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraProtocolHandler.java
index fdde01582a..aa961a3daf 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraProtocolHandler.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraProtocolHandler.java
@@ -41,7 +41,7 @@ public abstract class GhidraProtocolHandler implements ExtensionPoint {
/**
* Get the Ghidra protocol connector for a Ghidra URL which requires this
* extension.
- * @param url Ghidra protocol URL
+ * @param ghidraUrl Ghidra protocol URL
* @return Ghidra protocol connector
* @throws MalformedURLException if URL is invalid
*/
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraURL.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraURL.java
index fda9bb7f95..cb7ab2d37a 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraURL.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/protocol/ghidra/GhidraURL.java
@@ -174,7 +174,7 @@ public class GhidraURL {
/**
* Create a Ghidra URL from a string form of Ghidra URL or local project path.
* This method can consume strings produced by the getDisplayString method.
- * @param path project path (/)
+ * @param projectPathOrURL {@literal project path (/)}
* @return local Ghidra project URL
* @see #getDisplayString(URL)
* @throws IllegalArgumentException invalid path or URL specified
@@ -289,7 +289,7 @@ public class GhidraURL {
* Create a URL which refers to Ghidra Server repository content. Path may correspond
* to either a file or folder.
* @param host server host name/address
- * @param port optional server port (a value <= 0 refers to the default port)
+ * @param port optional server port (a value <= 0 refers to the default port)
* @param repositoryName repository name
* @param repositoryPath absolute folder or file path within repository.
* Folder paths should end with a '/' character.
@@ -303,7 +303,7 @@ public class GhidraURL {
* Create a URL which refers to Ghidra Server repository content. Path may correspond
* to either a file or folder.
* @param host server host name/address
- * @param port optional server port (a value <= 0 refers to the default port)
+ * @param port optional server port (a value <= 0 refers to the default port)
* @param repositoryName repository name
* @param repositoryPath absolute folder path within repository.
* @param fileName name of a file contained within the specified repository/path
@@ -352,7 +352,7 @@ public class GhidraURL {
/**
* Create a URL which refers to Ghidra Server repository and its root folder
* @param host server host name/address
- * @param port optional server port (a value <= 0 refers to the default port)
+ * @param port optional server port (a value <= 0 refers to the default port)
* @param repositoryName repository name
* @return Ghidra Server repository URL
*/
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GTaskManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GTaskManager.java
index 6c150722a8..ab10f97690 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GTaskManager.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/GTaskManager.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -45,7 +44,7 @@ import java.util.concurrent.locks.ReentrantLock;
* Suspending:
* The GTaskManager can be suspended. When suspended, any currently running task will continue to
* run, but no new or currently scheduled tasks will be executed until the GTaskManager is resumed.
- * There is a special method, {@link #runNextTaskEvenIfSuspended()}, that will run the next scheduled task
+ * There is a special method, {@link #runNextTaskEvenWhenSuspended()}, that will run the next scheduled task
* even if the GTaskManager is suspended.
*
* Yielding to Other Tasks:
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/emulator/EmulatorHelper.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/emulator/EmulatorHelper.java
index d95396e973..e2cae89336 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/emulator/EmulatorHelper.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/emulator/EmulatorHelper.java
@@ -318,7 +318,7 @@ public class EmulatorHelper implements MemoryFaultHandler, EmulatorConfiguration
/**
* Establish breakpoint
- * @param address memory address for new breakpoint
+ * @param addr memory address for new breakpoint
*/
public void setBreakpoint(Address addr) {
emulator.getBreakTable().registerAddressCallback(addr, addressBreak);
@@ -326,7 +326,7 @@ public class EmulatorHelper implements MemoryFaultHandler, EmulatorConfiguration
/**
* Clear breakpoint
- * @param address memory address for breakpoint to be cleared
+ * @param addr memory address for breakpoint to be cleared
*/
public void clearBreakpoint(Address addr) {
emulator.getBreakTable().unregisterAddressCallback(addr);
@@ -363,8 +363,8 @@ public class EmulatorHelper implements MemoryFaultHandler, EmulatorConfiguration
* Register callback for language defined pcodeop (call other).
* WARNING! Using this method may circumvent the default CALLOTHER emulation support
* when supplied by the Processor module.
- * @param pcodeOpName
- * @param callback
+ * @param pcodeOpName the name of the pcode op
+ * @param callback the callback to register
*/
public void registerCallOtherCallback(String pcodeOpName, BreakCallBack callback) {
emulator.getBreakTable().registerPcodeCallback(pcodeOpName, callback);
@@ -374,8 +374,7 @@ public class EmulatorHelper implements MemoryFaultHandler, EmulatorConfiguration
* Register default callback for language defined pcodeops (call other).
* WARNING! Using this method may circumvent the default CALLOTHER emulation support
* when supplied by the Processor module.
- * @param pcodeOpName
- * @param callback
+ * @param callback the default callback to register
*/
public void registerDefaultCallOtherCallback(BreakCallBack callback) {
emulator.getBreakTable().registerPcodeCallback("*", callback);
@@ -383,7 +382,7 @@ public class EmulatorHelper implements MemoryFaultHandler, EmulatorConfiguration
/**
* Unregister callback for language defined pcodeop (call other).
- * @param pcodeOpName
+ * @param pcodeOpName the name of the pcode op
*/
public void unregisterCallOtherCallback(String pcodeOpName) {
emulator.getBreakTable().unregisterPcodeCallback(pcodeOpName);
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assembler.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assembler.java
index 9b3c72ff96..a05df28c67 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assembler.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assembler.java
@@ -39,7 +39,7 @@ public interface Assembler {
* implement this method without a program binding. In that case, the returned instruction
* block will refer to pseudo instructions.
*
- * @note There must be an active transaction on the bound program for this method to succeed.
+ * NOTE: There must be an active transaction on the bound program for this method to succeed.
*
* @param at the location where the resulting instructions should be placed
* @param listing a new-line separated or array sequence of instructions
@@ -136,7 +136,7 @@ public interface Assembler {
/**
* Assemble a line instruction at the given address.
*
- * This method works like {@link #resolveLine(Address, String, AssemblyPatternBlock), except
+ * This method works like {@link #resolveLine(Address, String, AssemblyPatternBlock)}, except
* that it derives the context using {@link #getContextAt(Address)}.
* @param at the location of the start of the instruction
* @param line the textual assembly code
@@ -149,7 +149,7 @@ public interface Assembler {
/**
* Assemble a line instruction at the given address, assuming the given context.
*
- * This method works like {@link #assembleLine(Address,String,AssemblyPatternBlock}, except
+ * This method works like {@link #assembleLine(Address, String, AssemblyPatternBlock)}, except
* that it returns all possible resolutions for the parse trees that pass the
* {@link AssemblySelector}.
* @param at the location of the start of the instruction
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assemblers.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assemblers.java
index b2b1ec0fb7..0780eb9936 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assemblers.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/Assemblers.java
@@ -29,7 +29,7 @@ import ghidra.program.model.listing.Program;
* The primary class for obtaining an {@link Assembler} for a Ghidra-supported language.
*
* The general flow is: First, obtain an assembler for a language or program. Second, call its
- * {@link Assembler#assemble(Address, String)} and related methods to perform assembly. More
+ * {@link Assembler#assemble(Address, String...)} and related methods to perform assembly. More
* advanced uses pass a {@link AssemblySelector} to control certain aspects of assembly instruction
* selection, and to obtain advanced diagnostics, like detailed errors and code completion.
*
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssembler.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssembler.java
index 8e63e41d22..069a17c1b7 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssembler.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssembler.java
@@ -60,7 +60,7 @@ public class SleighAssembler implements Assembler {
* @param program the program to bind to (must have same language as parser)
* @param parser the parser for the SLEIGH language
* @param defaultContext the default context for the language
- * @param recGraphs the map of recursion graphs (shared by assemblers of this language)
+ * @param ctxGraph the context graph
*/
protected SleighAssembler(AssemblySelector selector, Program program, AssemblyParser parser,
AssemblyDefaultContext defaultContext, AssemblyContextGraph ctxGraph) {
@@ -76,13 +76,13 @@ public class SleighAssembler implements Assembler {
/**
* Construct a SleighAssembler.
*
- * @note This variant does not permit {@link #assemble(Address, String)}.
+ * NOTE: This variant does not permit {@link #assemble(Address, String...)}.
*
* @param selector a method of selecting one result from many
* @param lang the SLEIGH language (must be same as to create the parser)
* @param parser the parser for the SLEIGH language
- * @param ctxGraph
- * @param recGraphs the map of recursion graphs (shared by assemblers of this language)
+ * @param defaultContext the default context for the language
+ * @param ctxGraph the context graph
*/
protected SleighAssembler(AssemblySelector selector, SleighLanguage lang, AssemblyParser parser,
AssemblyDefaultContext defaultContext, AssemblyContextGraph ctxGraph) {
@@ -224,7 +224,7 @@ public class SleighAssembler implements Assembler {
* A convenience to obtain a map of program labels strings to long values
* @return the map
*
- * @TODO Use a Map instead so that, if possible, symbol values can be checked
+ * {@literal TODO Use a Map instead so that, if possible, symbol values can be checked}
* lest they be an invalid substitution for a given operand.
*/
protected Map getProgramLabels() {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssemblerBuilder.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssemblerBuilder.java
index 2524963d51..b61f114907 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssemblerBuilder.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/SleighAssemblerBuilder.java
@@ -75,9 +75,9 @@ import ghidra.util.SystemUtilities;
* semantic errors, then the overall result is an error.
*
* Some productions are "purely recursive," e.g., {@code :^instruction} lines in the SLEIGH. These
- * are ignored during parser construction. Let such a production be given as I => I. When resolving
+ * are ignored during parser construction. Let such a production be given as I => I. When resolving
* the parse tree to bytes, and we encounter a production with I on the left hand side, we then
- * consider the possible application of the production I => I and its consequential constructors.
+ * consider the possible application of the production I => I and its consequential constructors.
* Ideally, we could repeat this indefinitely, stopping when all further applications result in
* semantic errors; however, there is no guarantee in the SLEIGH specification that such an
* algorithm will actually halt, so a maximum number (default of 1) of applications are attempted.
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractBinaryExpressionSolver.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractBinaryExpressionSolver.java
index 2992055295..9c92585a26 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractBinaryExpressionSolver.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractBinaryExpressionSolver.java
@@ -130,7 +130,7 @@ public abstract class AbstractBinaryExpressionSolver
/**
* Compute the right-hand-side value given that the result and the left are known
*
- * @note Assumes commutativity by default
+ * NOTE: Assumes commutativity by default
* @param lval the left-hand-side value
* @param goal the result
* @return the right-hand-side value solution
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractUnaryExpressionSolver.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractUnaryExpressionSolver.java
index 3765d88a84..c673ee10ea 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractUnaryExpressionSolver.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AbstractUnaryExpressionSolver.java
@@ -72,7 +72,7 @@ public abstract class AbstractUnaryExpressionSolver
/**
* Compute the input value given that the result is known
*
- * @note Assumes an involution by default
+ * NOTE: Assumes an involution by default
* @param goal the result
* @return the input value solution
*/
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AndExpressionSolver.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AndExpressionSolver.java
index 6bacdc76f8..3dfa161324 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AndExpressionSolver.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/AndExpressionSolver.java
@@ -18,7 +18,7 @@ package ghidra.app.plugin.assembler.sleigh.expr;
import ghidra.app.plugin.processors.sleigh.expression.AndExpression;
/**
- * Solves expressions of the form A & B
+ * Solves expressions of the form {@code A & B}
*/
public class AndExpressionSolver extends AbstractBinaryExpressionSolver {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/EndInstructionValueSolver.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/EndInstructionValueSolver.java
index 2894a42c84..f23f0238e2 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/EndInstructionValueSolver.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/EndInstructionValueSolver.java
@@ -27,7 +27,7 @@ import ghidra.app.plugin.processors.sleigh.expression.EndInstructionValue;
* Works like the constant solver, but takes the value of {@code inst_next}, which is given by the
* assembly address and the resulting instruction length.
*
- * @note This solver requires backfill.
+ * NOTE: This solver requires backfill.
*/
public class EndInstructionValueSolver extends AbstractExpressionSolver {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/LeftShiftExpressionSolver.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/LeftShiftExpressionSolver.java
index 6ce6a8f9a6..7db45517c0 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/LeftShiftExpressionSolver.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/LeftShiftExpressionSolver.java
@@ -24,7 +24,7 @@ import ghidra.app.plugin.processors.sleigh.expression.LeftShiftExpression;
import ghidra.util.Msg;
/**
- * Solves expressions of the form A << B
+ * {@literal Solves expressions of the form A << B}
*/
public class LeftShiftExpressionSolver extends AbstractBinaryExpressionSolver {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/MaskedLong.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/MaskedLong.java
index ab84320295..5ea05ef447 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/MaskedLong.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/expr/MaskedLong.java
@@ -19,7 +19,7 @@ import ghidra.app.plugin.processors.sleigh.expression.TokenField;
import ghidra.util.NumericUtilities;
/**
- * A 64-bit value where each bit is {@code 0}, {@code 1}, or {@code x} (undefined)
+ * A {@code 64}-bit value where each bit is {@code 0}, {@code 1}, or {@code x} (undefined)
*/
public class MaskedLong implements Comparable {
public static final MaskedLong ZERO = new MaskedLong(-1, 0);
@@ -129,7 +129,7 @@ public class MaskedLong implements Comparable {
* Any {@code 0} bit in {@code msk} will result in an undefined bit in the result. {@code 1}
* bits result in a copy of the corresponding bit in the result.
*
- * @param msk the mask to apply
+ * @param mask the mask to apply
* @return the result.
*/
public MaskedLong mask(long mask) {
@@ -519,14 +519,14 @@ public class MaskedLong implements Comparable {
*
* To handle unknown bits, the result is derived from the following truth table:
*
- *
+ * {@literal
* 0 x 1 <= A (this)
* 0 0 0 0
* x 0 x x
* 1 0 x 1
* ^
* B (that)
- *
+ * }
*
* @param that the other masked long ({@code B}).
* @return the result.
@@ -546,19 +546,19 @@ public class MaskedLong implements Comparable {
}
/**
- * Solves the expression A & B = C, for B, given C and A
- *
+ * Solves the expression {@code A & B = C, for B, given C and A}
+ *
* To handle unknown bits, the solution is derived from the following truth table, where
* {@code *} indicates no solution:
*
- *
+ * {@literal
* 0 x 1 <= A (that)
* 0 x x 0
* x x x x
* 1 * 1 1
* ^
* B (this)
- *
+ * }
*
* @param that the other masked long ({@code B}).
* @return the result.
@@ -589,14 +589,14 @@ public class MaskedLong implements Comparable {
*
* To handle unknown bits, the result is derived from the following truth table:
*
- *
+ * {@literal
* 0 x 1 <= A (this)
* 0 0 x 1
* x x x 1
* 1 1 1 1
* ^
* B (that)
- *
+ * }
*
* @param that the other masked long ({@code B}).
* @return the result.
@@ -623,14 +623,14 @@ public class MaskedLong implements Comparable {
* To handle unknown bits, the solution is derived from the following truth table, where
* {@code *} indicates no solution:
*
- *
+ * {@literal
* 0 x 1 <= A (that)
* 0 0 0 *
* x x x x
* 1 1 x x
* ^
* B (this)
- *
+ * }
*
* @param that the other masked long ({@code B}).
* @return the result.
@@ -660,14 +660,14 @@ public class MaskedLong implements Comparable {
*
* To handle unknown bits, the result is derived from the following truth table:
*
- *
+ * {@literal
* 0 x 1 <= A (this)
* 0 0 x 1
* x x x x
* 1 1 x 0
* ^
* B (that)
- *
+ * }
*
* @param that the other masked long ({@code B}).
* @return the result.
@@ -698,10 +698,10 @@ public class MaskedLong implements Comparable {
*
* To handle unknown bits, the result is derived from the following truth table:
*
- *
+ *
|---|