Ghidra is a software reverse engineering (SRE) framework
GP-0: Javadoc fixes
Ryan Kurtz28f58b3e6295
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/InstructionSearchApi.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/InstructionSearchApi.javaindex 22f6cf219b..ec638e7ebe 100644--- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/InstructionSearchApi.java+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/InstructionSearchApi.java@@ -34,15 +34,15 @@ import ghidra.util.task.TaskMonitor;* <p>* Limitations:* <ol>- * <li>1) Searches may only be performed on a single program.- * <li>2) Only a single address range may be searched for.+ * <li>1) Searches may only be performed on a single program.</li>+ * <li>2) Only a single address range may be searched for.</li>* </ol>* <p>* Results:* Can be returned in 2 ways:* <ol>- * <li>1) As a list of addresses representing the location of search matches.- * <li>2) As a string (either binary or hex) representing the search string to be used.+ * <li>1) As a list of addresses representing the location of search matches.</li>+ * <li>2) As a string (either binary or hex) representing the search string to be used.</li>* </ol>* The latter results option is useful if using another tool to perform the search (i.e., Yara).* <p>diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/PortableExecutable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/PortableExecutable.javaindex 92e074162c..0e8ac2f166 100644--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/PortableExecutable.java+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/PortableExecutable.java@@ -118,7 +118,7 @@ public class PortableExecutable implements Writeable {}/**- * {@return the length of the {@link PortableExecutable} file in bytes+ * {@return the length of the {@link PortableExecutable} file in bytes}*/public long getFileLength() {return reader != null ? reader.length() : 0;diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SectionHeader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SectionHeader.javaindex 4d5358e7a1..f80a7b701e 100644--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SectionHeader.java+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SectionHeader.java@@ -411,7 +411,7 @@ public class SectionHeader implements StructConverter, ByteArrayConverter, Write}/**- * {@return the number of line numbers pointed to by the {@code NumberOfRelocations} field+ * {@return the number of line numbers pointed to by the {@code NumberOfRelocations} field}*/public short getNumberOfLinenumbers() {return numberOfLinenumbers;diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextComponentAutocompleter.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextComponentAutocompleter.javaindex 63e02ab770..197c1b4d42 100644--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextComponentAutocompleter.java+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextComponentAutocompleter.java@@ -405,9 +405,9 @@ public class TextComponentAutocompleter<T> {}/**- * Gets the prefix from the given text field, used to query the model.+ * Gets the prefix from the given component, used to query the model.*- * @param field an attached field, usually the one with focus.+ * @param component an attached component, usually the one with focus.* @return the prefix to use as the query.*/protected String getPrefix(JTextComponent component) {diff --git a/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/json/JsonDoclet.java b/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/json/JsonDoclet.javaindex d3bde96150..b490fbfe7f 100644--- a/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/json/JsonDoclet.java+++ b/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/json/JsonDoclet.java@@ -63,7 +63,7 @@ public class JsonDoclet implements Doclet {@Overridepublic SourceVersion getSupportedSourceVersion() {- return SourceVersion.RELEASE_21;+ return SourceVersion.RELEASE_25;}@Overridediff --git a/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/typestubs/PythonTypeStubDoclet.java b/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/typestubs/PythonTypeStubDoclet.javaindex 66dd8fb2aa..74afbbbe98 100644--- a/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/typestubs/PythonTypeStubDoclet.java+++ b/GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/typestubs/PythonTypeStubDoclet.java@@ -20,17 +20,10 @@ import java.util.*;import javax.lang.model.SourceVersion;import javax.lang.model.element.*;-import javax.lang.model.util.ElementFilter;-import javax.lang.model.util.Elements;-import javax.lang.model.util.Types;+import javax.lang.model.util.*;import javax.tools.Diagnostic.Kind;-import com.sun.source.doctree.DeprecatedTree;-import com.sun.source.doctree.DocCommentTree;-import com.sun.source.doctree.DocTree;-import com.sun.source.doctree.LinkTree;-import com.sun.source.doctree.StartElementTree;-import com.sun.source.doctree.TextTree;+import com.sun.source.doctree.*;import jdk.javadoc.doclet.*;@@ -64,7 +57,7 @@ public class PythonTypeStubDoclet implements Doclet {@Overridepublic SourceVersion getSupportedSourceVersion() {- return SourceVersion.RELEASE_21;+ return SourceVersion.RELEASE_25;}@Override@@ -307,10 +300,9 @@ public class PythonTypeStubDoclet implements Doclet {}/**- * Checks if the provided element is specified to be included by this doclet+ * {@return whether or not the provided element is specified to be included by this doclet}** @param element the element to check- * @return*/boolean isSpecified(Element element) {return useAllTypes || docEnv.getSpecifiedElements().contains(element);