diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFImporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFImporter.java index cf92957d084..cc20a696288 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFImporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFImporter.java @@ -200,9 +200,6 @@ private void addSourceLineInfo(BinaryReader reader) throws CancelledException, I /** * Imports DWARF information according to the {@link DWARFImportOptions} set. - *

- * {@link DWARFProgram#checkPreconditions(TaskMonitor)} must be called before this. - *

* @return * @throws IOException * @throws DWARFException diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFStringOffsetTableHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFStringOffsetTableHeader.java index ed7cf235ce9..427019aee81 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFStringOffsetTableHeader.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFStringOffsetTableHeader.java @@ -36,7 +36,6 @@ public class DWARFStringOffsetTableHeader extends DWARFIndirectTableHeader { /** * Reads a string offset table header (found in the .debug_str_offsets section) * - * @param dprog {@link DWARFProgram} * @param reader {@link BinaryReader} * @return new {@link DWARFStringOffsetTableHeader} instance * @throws IOException if error reading diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/util/FillOutStructureHelper.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/util/FillOutStructureHelper.java index 99d31cb07dd..057e30ad339 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/util/FillOutStructureHelper.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/util/FillOutStructureHelper.java @@ -166,8 +166,9 @@ private void init() { } /** - * Retrieve the component map that was generated when structure was created using decomiler info. - * Results are not valid until {@link #processStructure(HighVariable, Function, boolean)} is invoked. + * Retrieve the component map that was generated when structure was created using decompiler + * info. Results are not valid until + * {@link #processStructure(HighVariable, Function, boolean, boolean)} is invoked. * @return componentMap */ public NoisyStructureBuilder getComponentMap() { @@ -177,7 +178,8 @@ public NoisyStructureBuilder getComponentMap() { /** * Retrieve the offset/pcodeOp pairs that are used to store data into the variable * used to fill-out structure. - * Results are not valid until {@link #processStructure(HighVariable, Function, boolean)} is invoked. + * Results are not valid until + * {@link #processStructure(HighVariable, Function, boolean, boolean)} is invoked. * @return the pcodeOps doing the storing to the associated variable */ public List getStorePcodeOps() { @@ -187,7 +189,8 @@ public List getStorePcodeOps() { /** * Retrieve the offset/pcodeOp pairs that are used to load data from the variable * used to fill-out structure. - * Results are not valid until {@link #processStructure(HighVariable, Function, boolean)} is invoked. + * Results are not valid until + * {@link #processStructure(HighVariable, Function, boolean, boolean)} is invoked. * @return the pcodeOps doing the loading from the associated variable */ public List getLoadPcodeOps() { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/action/MenuData.java b/Ghidra/Framework/Docking/src/main/java/docking/action/MenuData.java index 286571f6ba5..f5cc17bb211 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/action/MenuData.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/action/MenuData.java @@ -116,8 +116,9 @@ public String getMenuPathAsString() { } /** - * Returns the menu path as a string. This method filters accelerator chars('&') from the path. - * @return the menu path as a string without unescaped '&' chars + * Returns the menu path as a string. This method filters accelerator chars('&') from the + * path. + * @return the menu path as a string without unescaped '&' chars */ public String getMenuPathDisplayString() { if (menuPath == null || menuPath.length == 0) { diff --git a/Ghidra/Framework/Emulation/src/main/java/generic/Span.java b/Ghidra/Framework/Emulation/src/main/java/generic/Span.java index 66f3928e4a6..02093a9f2bc 100644 --- a/Ghidra/Framework/Emulation/src/main/java/generic/Span.java +++ b/Ghidra/Framework/Emulation/src/main/java/generic/Span.java @@ -1082,7 +1082,7 @@ public void clear() { } /** - * Provides a default {@link #toString} implementation + * Provides a default {@link Object#toString} implementation * * @return the string */ diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java index e8863c4aa63..6ba339a75d9 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/model/DomainObjectListenerBuilder.java @@ -92,7 +92,7 @@ * * or if you also need the event (to get the domainObject that is the event source) * - *

  *   new DomainObjectListenerBuilder()
  *	.each(DomainObjectEvent.PROPERTY_CHANGED).call((e, r) -> processPropertyChanged(e, r))
  *	.withRecord(ProgramChangeRecord.class)
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolution.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolution.java
index c047e4dcb81..4cb4498177c 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolution.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolution.java
@@ -39,8 +39,10 @@ public abstract class AbstractAssemblyResolution implements AssemblyResolution {
 	/**
 	 * Construct a resolution
 	 * 
+	 * @param factory the factory
 	 * @param description a textual description used as part of {@link #toString()}
 	 * @param children for record keeping, any children used in constructing this resolution
+	 * @param right the right sibling
 	 */
 	protected AbstractAssemblyResolution(AbstractAssemblyResolutionFactory factory,
 			String description, List children,
@@ -149,6 +151,7 @@ public AssemblyResolution withoutRight() {
 	/**
 	 * Get this same resolution, but with the given right sibling
 	 * 
+	 * @param right the right sibling
 	 * @return the resolution
 	 */
 	public abstract AssemblyResolution withRight(AssemblyResolution right);
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolutionFactory.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolutionFactory.java
index 48fdeffc942..e42bf06539b 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolutionFactory.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AbstractAssemblyResolutionFactory.java
@@ -19,8 +19,6 @@
 import java.util.concurrent.atomic.AtomicLong;
 
 import ghidra.app.plugin.assembler.sleigh.expr.*;
-import ghidra.app.plugin.assembler.sleigh.sem.AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedBackfillBuilder;
-import ghidra.app.plugin.assembler.sleigh.sem.AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder;
 import ghidra.app.plugin.processors.sleigh.Constructor;
 import ghidra.app.plugin.processors.sleigh.expression.PatternExpression;
 import ghidra.app.plugin.processors.sleigh.pattern.DisjointPattern;
@@ -142,7 +140,7 @@ public AssemblyResolvedErrorBuilder newErrorBuilder() {
 	/**
 	 * Construct an immutable single-entry result set consisting of the one given resolution
 	 * 
-	 * @param rp the single resolution entry
+	 * @param one the single resolution entry
 	 * @return the new resolution set
 	 */
 	protected AssemblyResolutionResults singleton(AssemblyResolution one) {
@@ -185,7 +183,7 @@ protected AssemblyResolution solveOrBackfill(PatternExpression exp, MaskedLong g
 	 * a special case, if {@code bits == 0}, the goal is considered fully-defined (as if
 	 * {@code bits == 64}).
 	 * 
-	 * @see #solveOrBackfill(PatternExpression, MaskedLong, AssemblyResolvedPatterns, String)
+	 * @see #solveOrBackfill(PatternExpression, MaskedLong, Map, AssemblyResolvedPatterns, String)
 	 */
 	protected AssemblyResolution solveOrBackfill(PatternExpression exp, long goal, int bits,
 			Map vals, AssemblyResolvedPatterns cur, String description) {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolution.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolution.java
index 68f7f263fe3..5c6b41f43e0 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolution.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolution.java
@@ -41,7 +41,6 @@ public interface AssemblyResolution extends Comparable {
 	 * include in {@link #toString()}, it must override this method to return true when such
 	 * children are present.
 	 * 
-	 * @see #childrenToString(String)
 	 * @return true if this record has children
 	 */
 	boolean hasChildren();
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedBackfill.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedBackfill.java
index b45246fa8e5..b6b106b0db1 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedBackfill.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedBackfill.java
@@ -17,6 +17,7 @@
 
 import java.util.Map;
 
+import ghidra.app.plugin.assembler.sleigh.expr.NeedsBackfillException;
 import ghidra.app.plugin.assembler.sleigh.expr.RecursiveDescentSolver;
 
 public interface AssemblyResolvedBackfill extends AssemblyResolution {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedPatterns.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedPatterns.java
index 0f54c2e6e66..681184eda22 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedPatterns.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/AssemblyResolvedPatterns.java
@@ -90,8 +90,8 @@ public interface AssemblyResolvedPatterns extends AssemblyResolution {
 	/**
 	 * Decode a portion of the instruction block
 	 * 
-	 * @param start the first byte to decode
-	 * @param len the number of bytes to decode
+	 * @param byteStart the first byte to decode
+	 * @param size the number of bytes to decode
 	 * @return the read masked value
 	 * @see AssemblyPatternBlock#readBytes(int, int)
 	 */
@@ -126,7 +126,8 @@ public interface AssemblyResolvedPatterns extends AssemblyResolution {
 	 * Check if this and another resolution have equal encodings
 	 * 
 	 * 

- * This is like {@link #equals(Object)}, but it ignores backfill records and forbidden patterns. + * This is like {@link Object#equals(Object)}, but it ignores backfill records and forbidden + * patterns. * * @param that the other resolution * @return true if both have equal encodings @@ -145,7 +146,7 @@ public interface AssemblyResolvedPatterns extends AssemblyResolution { /** * Create a copy of this resolution with a new description * - * @param desc the new description + * @param description the new description * @return the copy */ AssemblyResolvedPatterns withDescription(String description); @@ -177,7 +178,7 @@ public interface AssemblyResolvedPatterns extends AssemblyResolution { * This combines corresponding pattern blocks (assuming they agree), collects backfill records, * and collects forbidden patterns. * - * @param that the other resolution + * @param pat the other resolution * @return the result if successful, or null */ AssemblyResolvedPatterns combine(AssemblyResolvedPatterns pat); @@ -312,7 +313,7 @@ AssemblyResolvedPatterns solveContextChangesForForbids(AssemblyConstructorSemant * NOTE: This drops all backfill and forbidden pattern records, since this method is * typically used to read token fields rather than passed around for resolution. * - * @param amt the number of bytes to remove from the left + * @param shamt the number of bytes to remove from the left * @return the result */ AssemblyResolvedPatterns truncate(int shamt); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedError.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedError.java index af7b55604c0..2098ee9221e 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedError.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedError.java @@ -49,9 +49,6 @@ public boolean equals(Object obj) { return true; } - /** - * @see AssemblyResolution#error(String, String, List) - */ protected DefaultAssemblyResolvedError(AbstractAssemblyResolutionFactory factory, String description, List children, AssemblyResolution right, String error) { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedPatterns.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedPatterns.java index eec7bdcebb6..69ee5fba3f6 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedPatterns.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/assembler/sleigh/sem/DefaultAssemblyResolvedPatterns.java @@ -62,10 +62,6 @@ public class DefaultAssemblyResolvedPatterns extends AbstractAssemblyResolution protected final Set backfills; protected final Set forbids; - /** - * @see AssemblyResolution#resolved(AssemblyPatternBlock, AssemblyPatternBlock, String, - * Constructor, List, AssemblyResolution) - */ protected DefaultAssemblyResolvedPatterns(AbstractAssemblyResolutionFactory factory, String description, Constructor cons, List children, AssemblyResolution right, AssemblyPatternBlock ins, AssemblyPatternBlock ctx, diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/disassemble/ReDisassembler.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/disassemble/ReDisassembler.java index e20ca800611..c4d9fbaa8b4 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/disassemble/ReDisassembler.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/disassemble/ReDisassembler.java @@ -273,13 +273,11 @@ protected Instruction nextInstruction(Flow flow, boolean isInDelaySlot) /** * Parse the next instructions, including delay-slotted ones * - * @param address the starting address + * @param flow the {@link Flow} * @return the if the first instruction has fall-through, the flow out from the last * instruction parsed. Without delay slots, the first instruction is the last * instruction. * @throws CancelledException - * @throws AddressOverflowException if an instruction would run past the end of the address - * space */ protected Flow nextInstructionsWithDelays(Flow flow) throws CancelledException { Instruction instruction = nextInstruction(flow, false); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java index 28e283a89d3..7106f75ccc3 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringRenderBuilder.java @@ -84,7 +84,6 @@ public void addEscapedCodePoint(int codePoint) { * escape sequences, depending on the RENDER_ENUM setting. * * @param bb {@link ByteBuffer} containing bytes of a string - * @param cs {@link Charset} that should be used to decode the bytes * @param renderSetting {@link RENDER_ENUM} * @param trimTrailingNulls boolean flag, if true trailing null bytes will not be included * in the rendered output diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java index 2760af8c9b6..8daa772c838 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/HighFunctionDBUtil.java @@ -84,7 +84,7 @@ public enum ReturnCommitOption { COMMIT, /** - * {@value #COMMIT_NO_VOID} - commit return parameter as defined by {@link HighFunction} + * {@link #COMMIT_NO_VOID} - commit return parameter as defined by {@link HighFunction} * unless it is {@link VoidDataType} in which case keep existing function return parameter. */ COMMIT_NO_VOID;