mirror/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-07-30 07:18:37 -09:00
Code Issues Packages Projects Releases Wiki Activity

GP-0: Javadoc fixes

Browse Source
This commit is contained in:
Ryan Kurtz
2026-07-08 10:23:06 -04:00
parent de2b218074
commit 28f58b3e62
6 changed files with 13 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/instructionsearch/InstructionSearchApi.java
View File

@@ -34,15 +34,15 @@ import ghidra.util.task.TaskMonitor;
* <p> * <p>
* Limitations: * Limitations:
* <ol> * <ol>
* <li>1) Searches may only be performed on a single program. * <li>1) Searches may only be performed on a single program.</li>
* <li>2) Only a single address range may be searched for. * <li>2) Only a single address range may be searched for.</li>
* </ol> * </ol>
* <p> * <p>
* Results: * Results:
* Can be returned in 2 ways: * Can be returned in 2 ways:
* <ol> * <ol>
* <li>1) As a list of addresses representing the location of search matches. * <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>2) As a string (either binary or hex) representing the search string to be used.</li>
* </ol> * </ol>
* The latter results option is useful if using another tool to perform the search (i.e., Yara). * The latter results option is useful if using another tool to perform the search (i.e., Yara).
* <p> * <p>

2
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/PortableExecutable.java
View File

@@ -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() { public long getFileLength() {
return reader != null ? reader.length() : 0; return reader != null ? reader.length() : 0;

2
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/SectionHeader.java
View File

@@ -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() { public short getNumberOfLinenumbers() {
return numberOfLinenumbers; return numberOfLinenumbers;

4
Ghidra/Framework/Docking/src/main/java/docking/widgets/autocomplete/TextComponentAutocompleter.java
View File

@@ -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. * @return the prefix to use as the query.
*/ */
protected String getPrefix(JTextComponent component) { protected String getPrefix(JTextComponent component) {

2
GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/json/JsonDoclet.java
View File

@@ -63,7 +63,7 @@ public class JsonDoclet implements Doclet {
@Override @Override
public SourceVersion getSupportedSourceVersion() { public SourceVersion getSupportedSourceVersion() {
return SourceVersion.RELEASE_21; return SourceVersion.RELEASE_25;
} }
@Override @Override

16
GhidraBuild/BuildFiles/Doclets/src/main/java/ghidra/doclets/typestubs/PythonTypeStubDoclet.java
View File

@@ -20,17 +20,10 @@ import java.util.*;
import javax.lang.model.SourceVersion; import javax.lang.model.SourceVersion;
import javax.lang.model.element.*; import javax.lang.model.element.*;
import javax.lang.model.util.ElementFilter; import javax.lang.model.util.*;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;
import javax.tools.Diagnostic.Kind; import javax.tools.Diagnostic.Kind;
import com.sun.source.doctree.DeprecatedTree; import com.sun.source.doctree.*;
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 jdk.javadoc.doclet.*; import jdk.javadoc.doclet.*;
@@ -64,7 +57,7 @@ public class PythonTypeStubDoclet implements Doclet {
@Override @Override
public SourceVersion getSupportedSourceVersion() { public SourceVersion getSupportedSourceVersion() {
return SourceVersion.RELEASE_21; return SourceVersion.RELEASE_25;
} }
@Override @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 * @param element the element to check
* @return
*/ */
boolean isSpecified(Element element) { boolean isSpecified(Element element) {
return useAllTypes || docEnv.getSpecifiedElements().contains(element); return useAllTypes || docEnv.getSpecifiedElements().contains(element);