Nixyri/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2024-11-23 20:52:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

GP-0: Fixing javadoc errors

Browse Source
This commit is contained in:
Ryan Kurtz 2024-06-12 08:00:20 -04:00
parent 0384d9d6fe
commit 715a8ba335
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/DataTypeMapper.java
View File

@ -34,8 +34,8 @@ import ghidra.util.task.TaskMonitor;
* To use the full might and majesty of StructureMapping™, a DataTypeMapper must be created. It
* must be able to {@link #addArchiveSearchCategoryPath(CategoryPath...) find}
* ({@link #addProgramSearchCategoryPath(CategoryPath...) more find}) the Ghidra structure data
* types being used, and it must {@link #registerStructure(Class) know} about all classes that are
* going to participate during deserialization and markup.
* types being used, and it must {@link #registerStructure(Class, DataTypeMapperContext) know} about
* all classes that are going to participate during deserialization and markup.
* <p>
* Structure mapped classes can receive a reference to the specific DataTypeMapper type that
* created them by declaring a {@code DataTypeMapper} field, and tagging it with
@ -217,7 +217,7 @@ public class DataTypeMapper implements AutoCloseable {
* @param <T> structure mapped class type
* @param clazz the class
* @return {@link StructureMappingInfo} for the specified class, or null if the class was
* not previously {@link #registerStructure(Class) registered}
* not previously {@link #registerStructure(Class, DataTypeMapperContext) registered}
*/
@SuppressWarnings("unchecked")
public <T> StructureMappingInfo<T> getStructureMappingInfo(Class<T> clazz) {
@ -232,7 +232,7 @@ public class DataTypeMapper implements AutoCloseable {
* @param structureInstance an instance of a previously registered
* {@link StructureMapping structure mapping} class, or null
* @return {@link StructureMappingInfo} for the instance, or null if the class was
* not previously {@link #registerStructure(Class) registered}
* not previously {@link #registerStructure(Class, DataTypeMapperContext) registered}
*/
@SuppressWarnings("unchecked")
public <T> StructureMappingInfo<T> getStructureMappingInfo(T structureInstance) {

6
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/structmapping/StructureMapping.java
View File

@ -34,9 +34,9 @@ import java.lang.annotation.*;
* In either case, various annotations on fields and methods will control how this structure
* will be marked up in the Ghidra program.
* <p>
* The tagged class must be {@link DataTypeMapper#registerStructure(Class) registered} with
* the {@link DataTypeMapper program context} to enable the suite of structure mapped classes
* to work together when applied to a Ghidra binary.
* The tagged class must be {@link DataTypeMapper#registerStructure(Class, DataTypeMapperContext)
* registered} with the {@link DataTypeMapper program context} to enable the suite of structure
* mapped classes to work together when applied to a Ghidra binary.
* <p>
* For variable length structure classes, when the struct mapping system creates a custom-fitted
* structure to markup a specific location with its specific data, the new struct data type's name