diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/DwarfDecoderFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/DwarfDecoderFactory.java index e29bdcbcea..b16abf9c63 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/DwarfDecoderFactory.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/DwarfDecoderFactory.java @@ -38,7 +38,7 @@ public class DwarfDecoderFactory { /** * Get the appropriate decoder for the given 8-bit mode; mode is parsed into * decode format, application mode, and indirection flag. - * @see #getDecoder(DwarfEHDataDecodeFormat, DwarfEHDataApplicationMode, boolean) + * @see #createDecoder(DwarfEHDataDecodeFormat, DwarfEHDataApplicationMode, boolean) * @param mode a byte that indicates an encoding * @return the decoder for the indicated mode of encoding */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/sections/AbstractFrameSection.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/sections/AbstractFrameSection.java index 352b65a0aa..64f0a5a4fb 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/sections/AbstractFrameSection.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/sections/AbstractFrameSection.java @@ -124,12 +124,12 @@ abstract class AbstractFrameSection implements CieSource { * @throws MemoryAccessException if memory for the CIE couldn't be read * @throws ExceptionHandlerFrameException if a problem was encountered */ - protected Cie getCieOrCreateIfMissing(Address currAddress, boolean isInDebugFrame) + protected Cie getCieOrCreateIfMissing(Address curAddress, boolean isInDebugFrame) throws MemoryAccessException, ExceptionHandlerFrameException { - Cie cie = cieMap.get(currAddress); + Cie cie = cieMap.get(curAddress); if (cie == null) { - cie = createCie(currAddress, isInDebugFrame); - cieMap.put(currAddress, cie); + cie = createCie(curAddress, isInDebugFrame); + cieMap.put(curAddress, cie); } return cie; } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/structures/gccexcepttable/LSDAActionTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/structures/gccexcepttable/LSDAActionTable.java index 3cd21b4c65..71864cd34a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/structures/gccexcepttable/LSDAActionTable.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/structures/gccexcepttable/LSDAActionTable.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 class LSDAActionTable { * Create an LSDA Action Table from the bytes at address. *
Note: This method must get called before any of the "get..." methods. * @param address the start (minimum address) of this action table. - * @param maxddress the end (maximum address) of this action table. + * @param maxAddress the end (maximum address) of this action table. */ public void create(Address address, Address maxAddress) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/FunctionMatchSet.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/FunctionMatchSet.java index 85f3565df7..ad4e7bce55 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/FunctionMatchSet.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/FunctionMatchSet.java @@ -36,9 +36,8 @@ public class FunctionMatchSet extends ArrayList { private final SymbolTable bSymbolTable; /** - * @param thisProgramName Name of this program (i.e. the program from - * which the matching was initiated. - * @param otherProgramName Name of the program being matched. + * @param aProgram The program from which the matching was initiated. + * @param bProgram The program being matched. */ public FunctionMatchSet(Program aProgram, Program bProgram) { super(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatchSet.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatchSet.java index cfb394f029..87efd931a8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatchSet.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/match/SubroutineMatchSet.java @@ -44,9 +44,8 @@ public class SubroutineMatchSet extends ArrayList { private final CodeBlockModel bModel; /** - * @param thisProgramName Name of this program (i.e. the program from - * which the matching was initiated. - * @param otherProgramName Name of the program being matched. + * @param aProgram The program from which the matching was initiated. + * @param bProgram The program being matched. */ public SubroutineMatchSet(Program aProgram, CodeBlockModel aModel, Program bProgram, CodeBlockModel bModel) { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DIEAggregate.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DIEAggregate.java index df0c9c0c54..9c7d7a46d5 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DIEAggregate.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DIEAggregate.java @@ -926,7 +926,7 @@ public class DIEAggregate { * This indicates an empty range, in which case the caller may want to take * special steps to avoid issues with Ghidra ranges. *

- * Only seen in extremely old gcc versions. Typically the low & high + * Only seen in extremely old gcc versions. Typically the low and high * pc values are omitted if the CU is empty. * * @return boolean true if the LowPC and HighPC values are present and equal diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DWARFLine.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DWARFLine.java index 2f1d73df26..6baddbbfca 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DWARFLine.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf4/DWARFLine.java @@ -48,7 +48,7 @@ public class DWARFLine { * DebugLine stream (if present). * * @param diea {@link DIEAggregate} compile unit DIE(a) - * @return a new DWARFLine instance if DW_AT_stmt_list & stream are present, otherwise null + * @return a new DWARFLine instance if DW_AT_stmt_list and stream are present, otherwise null * @throws IOException if error reading data * @throws DWARFException if bad DWARF values */ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/relocation/ElfRelocationHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/relocation/ElfRelocationHandler.java index 4b35e3aa8a..b911a99ab8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/relocation/ElfRelocationHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/elf/relocation/ElfRelocationHandler.java @@ -74,7 +74,7 @@ abstract public class ElfRelocationHandler implements ExtensionPoint { /** * Determine if symbolAddr is contained within the EXTERNAL block. If so, relocationAddress will be marked - * with a error bookmark. + * with a Unsupported EXTERNAL Data Elf Relocation error bookmark. * NOTE: This method should only be invoked when the symbol offset will be adjust with a non-zero * value (i.e., addend). * @param program diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java index a885e7dadf..e00b6fd137 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java @@ -35,7 +35,7 @@ public interface OverviewProvider { * Sets the current program and associated address-index map * * @param program the program to use. - * @param addressIndexMap the address-index map to use. + * @param map the address-index map to use. */ void setProgram(Program program, AddressIndexMap map); 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 920a703380..fa92a0d90b 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 @@ -88,7 +88,7 @@ public class FileSystemService { * null, * "the_derived_file", * -1, - * () -> new MySpecialtyInputstream(), + * () -> new MySpecialtyInputstream(), * monitor); *

* See {@link #produceDerivedStream()}. @@ -122,7 +122,7 @@ public class FileSystemService { * null, * "the_derived_file", * -1, - * os -> FileUtilities.copyStream(my_input_stream, os), + * os -> FileUtilities.copyStream(my_input_stream, os), * monitor); *

* See {@link #push(OutputStream)}. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java index 031a46b9bc..ff2f2f145f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/factory/FileSystemFactoryMgr.java @@ -242,8 +242,7 @@ public class FileSystemFactoryMgr { * if found, creates a new filesystem instance. *

* - * @param containerFSRL {@link FSRL} of the containing file. - * @param containerFile {@link File} the containing file. + * @param byteProvider container {@link ByteProvider}, will be owned by the new filesystem * @param fsService reference to the {@link FileSystemService} instance. * @param conflictResolver {@link FileSystemProbeConflictResolver conflict resolver} to * use when more than one {@link GFileSystem} implementation can handle the specified diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java index eb7065c821..c764a4e56b 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/filechooser/LocalFileChooserModel.java @@ -98,9 +98,6 @@ public class LocalFileChooserModel implements GhidraFileChooserModel { return desktop.isDirectory() ? desktop : null; } - /** - * @see ghidra.util.filechooser.GhidraFileChooserModel#getRoots() - */ @Override public File[] getRoots(boolean forceUpdate) { if (roots.length == 0 || forceUpdate) { 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 5b07f4e8b2..445ec8d6f5 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 @@ -527,8 +527,8 @@ public class TextFieldLinker { * with the results of {@link #getText()} will have unexpected effects. * * @param field the field to link - * @param exp the separator following the field - * @param sep the separator that replaces {@code exp} when matched + * @param pat the regular expression to search for following the field + * @param sep the separator that replaces {@code pat} when matched */ public void linkField(JTextField field, Pattern pat, String sep) { checkLast(); diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/VertexShape.java b/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/VertexShape.java index ebf57de13b..51fbd3b41f 100644 --- a/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/VertexShape.java +++ b/Ghidra/Framework/Graph/src/main/java/ghidra/service/graph/VertexShape.java @@ -88,7 +88,7 @@ public abstract class VertexShape { /** * Returns the size factor for a shape relative to its label. Shapes are sized based on the * label of a vertex so that the label can fit inside the shape (mostly). Some subclasses - * will need to override this value to some value > 1 to fit the label in the shape. For + * will need to override this value to some value > 1 to fit the label in the shape. For * example, a rectangle shape does not need to be extended because text naturally fits. But * for a shape like a triangle, its bounding box needs to be bigger so that text doesn't * "stick out" in the narrow part of the triangle. diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java index 085e08bf3c..e397e171e5 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/CompositeInternal.java @@ -157,7 +157,7 @@ public interface CompositeInternal extends Composite { } /** - * Dump composite and its components for use in {@link #toString()} representation. + * Dump composite and its components for use in {@link Object#toString()} representation. * @param composite composite instance to be dumped * @return formatted dump as string */ @@ -174,7 +174,7 @@ public interface CompositeInternal extends Composite { } /** - * Dump all components for use in {@link #toString()} representation. + * Dump all components for use in {@link Object#toString()} representation. * * @param buffer string buffer * @param pad padding to be used with each component output line diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DynamicDataType.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DynamicDataType.java index 504e94a646..645c818dae 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DynamicDataType.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DynamicDataType.java @@ -111,7 +111,7 @@ public abstract class DynamicDataType extends BuiltIn implements Dynamic { /** * Returns the first component containing the byte at the given offset. - * It is possible with zero-length components (see {@link DataTypeComponent#isZeroLength()}) + * It is possible with zero-length components (see {@link DataType#isZeroLength()}) * and bitfields (see @DataTypeComponent#isBitFieldComponent()} for multiple components * to share the same offset. * @param offset the offset into the dataType diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Instruction.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Instruction.java index d56d104459..8f619b6c16 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Instruction.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/Instruction.java @@ -198,11 +198,6 @@ public interface Instruction extends CodeUnit, ProcessorContext { * Get an array of PCode operations (micro code) that this instruction * performs. NOTE: If includeOverrides is true, unique temporary varnodes * may be produced which vary in size to those produced for other instructions. - * If your analysis is sensitive to this you should consider using - * {@link InstructionPrototype#getPcode(InstructionContext, PcodeOverride, UniqueAddressFactory)} - * instead with your own {@link UniqueAddressFactory} to prevent duplication within - * your scope of analysis. - * by this method may not be suitable for use with certain analysis * @param includeOverrides if true any flow overrides will be factored * into generated pcode. * @return an array of Pcode operations,